javax.swing.plaf.synth
Class SynthContext
- java.lang.Object
-
- javax.swing.plaf.synth.SynthContext
-
public class SynthContext extends Object
An immutable transient object containing contextual information about aRegion. ASynthContextshould only be considered valid for the duration of the method it is passed to. In other words you should not cache aSynthContextthat 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
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description JComponentgetComponent()Returns the hosting component containing the region.intgetComponentState()Returns the state of the widget, which is a bitmask of the values defined inSynthConstants.RegiongetRegion()Returns the Region identifying this state.SynthStylegetStyle()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- JComponent -
region- Identifies the portion of the JComponent -
style- Style associated with the component -
state- 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,PRESSEDorDISABLED.- Returns:
- State of Component
- See Also:
-
SynthConstants
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
