- java.lang.Object
-
- javax.swing.plaf.synth.SynthContext
-
public class SynthContext extends Object
An immutable transient object containing contextual information about aRegion
. ASynthContext
should only be considered valid for the duration of the method it is passed to. In other words you should not cache aSynthContext
that is passed to you and expect it to remain valid.- Since:
- 1.5
-
-
Constructor Summary
Constructors Constructor and Description SynthContext(JComponent component, Region region, SynthStyle style, int state)
Creates a SynthContext with the specified values.
-
Method Summary
Methods Modifier and Type Method and Description JComponent
getComponent()
Returns the hosting component containing the region.int
getComponentState()
Returns the state of the widget, which is a bitmask of the values defined inSynthConstants
.Region
getRegion()
Returns the Region identifying this state.SynthStyle
getStyle()
Returns the style associated with this Region.
-
-
-
Constructor Detail
-
SynthContext
public SynthContext(JComponent component, Region region, SynthStyle style, int state)
Creates a SynthContext with the specified values. This is meant for subclasses and custom UI implementors. You very rarely need to construct a SynthContext, though some methods will take one.- Parameters:
component
- JComponentregion
- Identifies the portion of the JComponentstyle
- Style associated with the componentstate
- State of the component as defined in SynthConstants.- Throws:
NullPointerException
- if component, region of style is null.
-
-
Method Detail
-
getComponent
public JComponent getComponent()
Returns the hosting component containing the region.- Returns:
- Hosting Component
-
getRegion
public Region getRegion()
Returns the Region identifying this state.- Returns:
- Region of the hosting component
-
getStyle
public SynthStyle getStyle()
Returns the style associated with this Region.- Returns:
- SynthStyle associated with the region.
-
getComponentState
public int getComponentState()
Returns the state of the widget, which is a bitmask of the values defined inSynthConstants
. A region will at least be in one ofENABLED
,MOUSE_OVER
,PRESSED
orDISABLED
.- Returns:
- State of Component
- See Also:
SynthConstants
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/plaf/synth/synthcontext.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.