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
    Description
    SynthContext(JComponent component, Region region, SynthStyle style, int state)
    Creates a SynthContext with the specified values.

  • Method Summary

    Modifier and Type
    Method
    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 declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Creates and returns a copy of this object.
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    getClass()
    Returns the runtime class of this Object.
    int
    hashCode()
    Returns a hash code value for this object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    String
    toString()
    Returns a string representation of the object.
    final void
    wait()
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  • Constructor Details

    • 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 Details

    • 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: