Source for javax.swing.plaf.synth.SynthContext

   1: /* SynthContext.java -- Contextual information about a region
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.swing.plaf.synth;
  40: 
  41: import javax.swing.JComponent;
  42: 
  43: /**
  44:  * Contains some contextual information about a region. The information passed
  45:  * in objects of this class can only be considered valid during the method call
  46:  * that it was passed to.
  47:  *
  48:  * @author Roman Kennke (kennke@aicas.com)
  49:  *
  50:  * @since 1.5
  51:  */
  52: public class SynthContext
  53: {
  54: 
  55:   /**
  56:    * The component.
  57:    */
  58:   private JComponent component;
  59: 
  60:   /**
  61:    * The region of the component.
  62:    */
  63:   private Region region;
  64: 
  65:   /**
  66:    * The style of the component.
  67:    */
  68:   private SynthStyle style;
  69: 
  70:   /**
  71:    * The state of the component.
  72:    */
  73:   private int state;
  74: 
  75:   /**
  76:    * Creates a new <code>SynthContext</code> object.
  77:    *
  78:    * @param component the component for which this context is used
  79:    * @param region the region of the component
  80:    * @param style the style associated with the component
  81:    * @param state a or'ed bitmask of the constants from {@link SynthConstants}
  82:    */
  83:   public SynthContext(JComponent component, Region region, SynthStyle style,
  84:                       int state)
  85:   {
  86:     this.component = component;
  87:     this.region = region;
  88:     this.style = style;
  89:     this.state = state;
  90:   }
  91: 
  92:   /**
  93:    * Returns the component that contains the region.
  94:    *
  95:    * @return the component that contains the region
  96:    */
  97:   public JComponent getComponent()
  98:   {
  99:     return component;
 100:   }
 101: 
 102:   /**
 103:    * Returns the region that identifies this state.
 104:    *
 105:    * @return the region that identifies this state
 106:    */
 107:   public Region getRegion()
 108:   {
 109:     return region;
 110:   }
 111: 
 112:   /**
 113:    * Returns the style of the region.
 114:    *
 115:    * @return the style of the region
 116:    */
 117:   public SynthStyle getStyle()
 118:   {
 119:     return style;
 120:   }
 121: 
 122:   /**
 123:    * Returns the state of the component. This is a or'ed bitmask of the
 124:    * constants defined in {@link SynthConstants}.
 125:    *
 126:    * @return the state of the component
 127:    *
 128:    * @see SynthConstants
 129:    */
 130:   public int getComponentState()
 131:   {
 132:     return state;
 133:   }
 134: }