| |
|
| java.lang.Object
 javax.swing.plaf.synth.SynthStyle
| SynthStyle | | abstract public class SynthStyle (Code) | | SynthStyle is a set of style properties.
Each SynthUI references at least one
SynthStyle that is obtained using a
SynthStyleFactory. You typically don't need to interact with
this class directly, rather you will load a
Synth File Format file into
SynthLookAndFeel that will create a set of SynthStyles.
See Also: SynthLookAndFeel
See Also: SynthStyleFactory
version:
1.44, 05/05/07
since:
1.5
author:
Scott Violet |
| Constructor Summary | |
| public | SynthStyle()
Constructs a SynthStyle. |
| Method Summary | |
| public Object | get(SynthContext context, Object key)
Getter for a region specific style property.
Parameters:
context - SynthContext identifying requester
Parameters:
key - Property being requested. | | public boolean | getBoolean(SynthContext context, Object key, boolean defaultValue)
Convenience method to get a specific style property whose value is
an Boolean. | | public Color | getColor(SynthContext context, ColorType type)
Returns the color for the specified state. | | abstract protected Color | getColorForState(SynthContext context, ColorType type)
Returns the color for the specified state. | | public Font | getFont(SynthContext context)
Returns the Font for the specified state. | | abstract protected Font | getFontForState(SynthContext context)
Returns the font for the specified state. | | public SynthGraphicsUtils | getGraphicsUtils(SynthContext context)
Returns the SynthGraphicUtils for the specified context. | | public Icon | getIcon(SynthContext context, Object key)
Convenience method to get a specific style property whose value is
an Icon.
Parameters:
context - SynthContext identifying requester
Parameters:
key - Property being requested. | | public Insets | getInsets(SynthContext context, Insets insets)
Returns the Insets that are used to calculate sizing information.
Parameters:
context - SynthContext identifying requester
Parameters:
insets - Insets to place return value in. | | public int | getInt(SynthContext context, Object key, int defaultValue)
Convenience method to get a specific style property whose value is
a Number. | | public SynthPainter | getPainter(SynthContext context)
Returns the SynthPainter that will be used for painting. | | public String | getString(SynthContext context, Object key, String defaultValue)
Convenience method to get a specific style property whose value is
a String. | | void | installDefaults(SynthContext context, SynthUI ui)
| | public void | installDefaults(SynthContext context)
Installs the necessary state from this Style on the
JComponent from context. | | public boolean | isOpaque(SynthContext context)
Returns true if the region is opaque. | | public void | uninstallDefaults(SynthContext context)
Uninstalls any state that this style installed on
the JComponent from context. |
| SynthStyle | | public SynthStyle()(Code) | | Constructs a SynthStyle.
|
| get | | public Object get(SynthContext context, Object key)(Code) | | Getter for a region specific style property.
Parameters:
context - SynthContext identifying requester
Parameters:
key - Property being requested. Value of the named property |
| getBoolean | | public boolean getBoolean(SynthContext context, Object key, boolean defaultValue)(Code) | | Convenience method to get a specific style property whose value is
an Boolean.
Parameters:
context - SynthContext identifying requester
Parameters:
key - Property being requested.
Parameters:
defaultValue - Value to return if the property has not beenspecified, or is not a Boolean Value of the named property |
| getColor | | public Color getColor(SynthContext context, ColorType type)(Code) | | Returns the color for the specified state. This gives precedence to
foreground and background of the JComponent. If the
Color from the JComponent is not appropriate,
or not used, this will invoke getColorForState. Subclasses
should generally not have to override this, instead override
SynthStyle.getColorForState .
Parameters:
context - SynthContext identifying requester
Parameters:
type - Type of color being requested. Color |
| getColorForState | | abstract protected Color getColorForState(SynthContext context, ColorType type)(Code) | | Returns the color for the specified state. This should NOT call any
methods on the JComponent.
Parameters:
context - SynthContext identifying requester
Parameters:
type - Type of color being requested. Color to render with |
| getFont | | public Font getFont(SynthContext context)(Code) | | Returns the Font for the specified state. This redirects to the
JComponent from the context as necessary.
If this does not redirect
to the JComponent
SynthStyle.getFontForState is invoked.
Parameters:
context - SynthContext identifying requester Font to render with |
| getFontForState | | abstract protected Font getFontForState(SynthContext context)(Code) | | Returns the font for the specified state. This should NOT call any
method on the JComponent.
Parameters:
context - SynthContext identifying requester Font to render with |
| getGraphicsUtils | | public SynthGraphicsUtils getGraphicsUtils(SynthContext context)(Code) | | Returns the SynthGraphicUtils for the specified context.
Parameters:
context - SynthContext identifying requester SynthGraphicsUtils |
| getIcon | | public Icon getIcon(SynthContext context, Object key)(Code) | | Convenience method to get a specific style property whose value is
an Icon.
Parameters:
context - SynthContext identifying requester
Parameters:
key - Property being requested. Value of the named property, or null if not specified |
| getInsets | | public Insets getInsets(SynthContext context, Insets insets)(Code) | | Returns the Insets that are used to calculate sizing information.
Parameters:
context - SynthContext identifying requester
Parameters:
insets - Insets to place return value in. Sizing Insets. |
| getInt | | public int getInt(SynthContext context, Object key, int defaultValue)(Code) | | Convenience method to get a specific style property whose value is
a Number. If the value is a Number,
intValue is returned, otherwise defaultValue
is returned.
Parameters:
context - SynthContext identifying requester
Parameters:
key - Property being requested.
Parameters:
defaultValue - Value to return if the property has not beenspecified, or is not a Number Value of the named property |
| getPainter | | public SynthPainter getPainter(SynthContext context)(Code) | | Returns the SynthPainter that will be used for painting.
This may return null.
Parameters:
context - SynthContext identifying requester SynthPainter to use |
| getString | | public String getString(SynthContext context, Object key, String defaultValue)(Code) | | Convenience method to get a specific style property whose value is
a String.
Parameters:
context - SynthContext identifying requester
Parameters:
key - Property being requested.
Parameters:
defaultValue - Value to return if the property has not beenspecified, or is not a String Value of the named property |
| installDefaults | | public void installDefaults(SynthContext context)(Code) | | Installs the necessary state from this Style on the
JComponent from context.
Parameters:
context - SynthContext identifying component to install propertiesto. |
| isOpaque | | public boolean isOpaque(SynthContext context)(Code) | | Returns true if the region is opaque.
Parameters:
context - SynthContext identifying requester true if region is opaque. |
| uninstallDefaults | | public void uninstallDefaults(SynthContext context)(Code) | | Uninstalls any state that this style installed on
the JComponent from context.
Styles should NOT depend upon this being called, in certain cases
it may never be called.
Parameters:
context - SynthContext identifying component to install propertiesto. |
|
|
|