SynthContext (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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 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.

Constructor Summary
`SynthContext(JComponent component, Region region, SynthStyle style, int state)` Creates a SynthContext with the specified values.

Method Summary
`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 in `SynthConstants`.
`Region`	`getRegion()` Returns the Region identifying this state.
`SynthStyle`	`getStyle()` Returns the style associated with this Region.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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.

Method Detail

getComponent

public JComponent getComponent()

Returns the hosting component containing the region.

Returns:: Hosting Component

getComponentState

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:: State of 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.