001/* SynthContext.java -- Contextual information about a region 002 Copyright (C) 2006 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package javax.swing.plaf.synth; 040 041import javax.swing.JComponent; 042 043/** 044 * Contains some contextual information about a region. The information passed 045 * in objects of this class can only be considered valid during the method call 046 * that it was passed to. 047 * 048 * @author Roman Kennke (kennke@aicas.com) 049 * 050 * @since 1.5 051 */ 052public class SynthContext 053{ 054 055 /** 056 * The component. 057 */ 058 private JComponent component; 059 060 /** 061 * The region of the component. 062 */ 063 private Region region; 064 065 /** 066 * The style of the component. 067 */ 068 private SynthStyle style; 069 070 /** 071 * The state of the component. 072 */ 073 private int state; 074 075 /** 076 * Creates a new <code>SynthContext</code> object. 077 * 078 * @param component the component for which this context is used 079 * @param region the region of the component 080 * @param style the style associated with the component 081 * @param state a or'ed bitmask of the constants from {@link SynthConstants} 082 */ 083 public SynthContext(JComponent component, Region region, SynthStyle style, 084 int state) 085 { 086 this.component = component; 087 this.region = region; 088 this.style = style; 089 this.state = state; 090 } 091 092 /** 093 * Returns the component that contains the region. 094 * 095 * @return the component that contains the region 096 */ 097 public JComponent getComponent() 098 { 099 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}