OpenJDK 27 · javax.swing.plaf.synth.SynthContext · APIdia, the JavaDoc alternative

An immutable transient object containing contextual information about a Region. A SynthContext should only be considered valid for the duration of the method it is passed to. In other words you should not cache a SynthContext that is passed to you and expect it to remain valid.

Modifier and Type	Field and Description
private JComponent	component
private Region	region
private int	state
private SynthStyle	style

Constructor Summary

Access	Constructor and Description
private	SynthContext()
public	SynthContext(JComponent JComponent component, Region Identifies the portion of the JComponent region, SynthStyle Style associated with the component style, int State of the component as defined in SynthConstants. state) Creates a SynthContext with the specified values.

Method Summary

Modifier and Type	Method and Description
public JComponent	Returns: Hosting Component getComponent() Returns the hosting component containing the region.
public int	Returns: State of Component getComponentState() Returns the state of the widget, which is a bitmask of the values defined in `SynthConstants`.
pack-priv static SynthContext	getContext(JComponent c, SynthStyle style, int state)
pack-priv static SynthContext	getContext(JComponent component, Region region, SynthStyle style, int state)
pack-priv SynthPainter	getPainter() Convenience method to get the Painter from the current SynthStyle.
public Region	Returns: Region of the hosting component getRegion() Returns the Region identifying this state.
public SynthStyle	Returns: SynthStyle associated with the region. getStyle() Returns the style associated with this Region.
pack-priv boolean	isSubregion() A convenience method for `getRegion().isSubregion()`.
pack-priv void	setComponentState(int state)
pack-priv void	setStyle(SynthStyle style)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

component	back to summary
private JComponent component

region	back to summary
private Region region

state	back to summary
private int state

style	back to summary
private SynthStyle style

Constructor Detail

SynthContext	back to summary
private SynthContext()

SynthContext	back to summary
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 JComponent region:Region Identifies the portion of the JComponent style:SynthStyle Style associated with the component state:int State of the component as defined in SynthConstants. Exceptions NullPointerException: if component, region of style is null.

SynthContext

back to summary

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: JComponent
region:Region: Identifies the portion of the JComponent
style:SynthStyle: Style associated with the component
state:int: State of the component as defined in SynthConstants.

Exceptions

NullPointerException:: if component, region of style is null.

Method Detail

getComponent	back to summary
public JComponent getComponent() Returns the hosting component containing the region. Returns:JComponent Hosting Component

getComponent

back to summary

public JComponent getComponent()

Returns the hosting component containing the region.

Returns:JComponent: Hosting Component

getComponentState back to summary

getComponentState	back to summary
public int getComponentState() Returns the state of the widget, which is a bitmask of the values defined in `SynthConstants`. A region will at least be in one of `ENABLED`, `MOUSE_OVER`, `PRESSED` or `DISABLED`. Returns:int State of Component See Also `SynthConstants`

public int getComponentState()

Returns the state of the widget, which is a bitmask of the values defined in SynthConstants. A region will at least be in one of ENABLED, MOUSE_OVER, PRESSED or DISABLED.

Returns:int: State of Component
See Also: SynthConstants

getContext	back to summary
pack-priv static SynthContext getContext(JComponent c, SynthStyle style, int state)

getContext	back to summary
pack-priv static SynthContext getContext(JComponent component, Region region, SynthStyle style, int state)

getPainter	back to summary
pack-priv SynthPainter getPainter() Convenience method to get the Painter from the current SynthStyle. This will NEVER return null.

getRegion	back to summary
public Region getRegion() Returns the Region identifying this state. Returns:Region Region of the hosting component

getRegion

back to summary

public Region getRegion()

Returns the Region identifying this state.

Returns:Region: Region of the hosting component

getStyle	back to summary
public SynthStyle getStyle() Returns the style associated with this Region. Returns:SynthStyle SynthStyle associated with the region.

getStyle

back to summary

public SynthStyle getStyle()

Returns the style associated with this Region.

Returns:SynthStyle: SynthStyle associated with the region.

isSubregion	back to summary
pack-priv boolean isSubregion() A convenience method for `getRegion().isSubregion()`.

setComponentState	back to summary
pack-priv void setComponentState(int state)

setStyle	back to summary
pack-priv void setStyle(SynthStyle style)

public Class SynthContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail