SynthContext (Java Platform SE 8 )
Keywords: javax.swing.plaf.synth.SynthContext class
Date: 2015-11-19

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.
  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
    --- | ---
    `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.
      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 in `SynthConstants`. A region will at least be in one of `ENABLED`, `MOUSE_OVER`, `PRESSED` or `DISABLED`.
      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, 2015, Oracle and/or its affiliates. All rights reserved.