java.lang.Object
javax.swing.plaf.synth.SynthStyle
- Direct Known Subclasses:
NimbusStyle
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.- Since:
- 1.5
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionget
(SynthContext context, Object key) Getter for a region specific style property.boolean
getBoolean
(SynthContext context, Object key, boolean defaultValue) Convenience method to get a specific style property whose value is an Boolean.getColor
(SynthContext context, ColorType type) Returns the color for the specified state.protected abstract Color
getColorForState
(SynthContext context, ColorType type) Returns the color for the specified state.getFont
(SynthContext context) Returns the Font for the specified state.protected abstract Font
getFontForState
(SynthContext context) Returns the font for the specified state.getGraphicsUtils
(SynthContext context) Returns theSynthGraphicUtils
for the specified context.getIcon
(SynthContext context, Object key) Convenience method to get a specific style property whose value is an Icon.getInsets
(SynthContext context, Insets insets) Returns the Insets that are used to calculate sizing information.int
getInt
(SynthContext context, Object key, int defaultValue) Convenience method to get a specific style property whose value is aNumber
.getPainter
(SynthContext context) Returns theSynthPainter
that will be used for painting.getString
(SynthContext context, Object key, String defaultValue) Convenience method to get a specific style property whose value is a String.void
installDefaults
(SynthContext context) Installs the necessary state from this Style on theJComponent
fromcontext
.boolean
isOpaque
(SynthContext context) Returns true if the region is opaque.void
uninstallDefaults
(SynthContext context) Uninstalls any state that this style installed on theJComponent
fromcontext
.
-
Constructor Details
-
SynthStyle
public SynthStyle()Constructs a SynthStyle.
-
-
Method Details
-
getGraphicsUtils
Returns theSynthGraphicUtils
for the specified context.- Parameters:
context
- SynthContext identifying requester- Returns:
- SynthGraphicsUtils
-
getColor
Returns the color for the specified state. This gives precedence to foreground and background of theJComponent
. If theColor
from theJComponent
is not appropriate, or not used, this will invokegetColorForState
. Subclasses should generally not have to override this, instead overridegetColorForState(javax.swing.plaf.synth.SynthContext, javax.swing.plaf.synth.ColorType)
.- Parameters:
context
- SynthContext identifying requestertype
- Type of color being requested.- Returns:
- Color
-
getColorForState
Returns the color for the specified state. This should NOT call any methods on theJComponent
.- Parameters:
context
- SynthContext identifying requestertype
- Type of color being requested.- Returns:
- Color to render with
-
getFont
Returns the Font for the specified state. This redirects to theJComponent
from thecontext
as necessary. If this does not redirect to the JComponentgetFontForState(javax.swing.plaf.synth.SynthContext)
is invoked.- Parameters:
context
- SynthContext identifying requester- Returns:
- Font to render with
-
getFontForState
Returns the font for the specified state. This should NOT call any method on theJComponent
.- Parameters:
context
- SynthContext identifying requester- Returns:
- Font to render with
-
getInsets
Returns the Insets that are used to calculate sizing information.- Parameters:
context
- SynthContext identifying requesterinsets
- Insets to place return value in.- Returns:
- Sizing Insets.
-
getPainter
Returns theSynthPainter
that will be used for painting. This may return null.- Parameters:
context
- SynthContext identifying requester- Returns:
- SynthPainter to use
-
isOpaque
Returns true if the region is opaque.- Parameters:
context
- SynthContext identifying requester- Returns:
- true if region is opaque.
-
get
Getter for a region specific style property.- Parameters:
context
- SynthContext identifying requesterkey
- Property being requested.- Returns:
- Value of the named property
-
installDefaults
Installs the necessary state from this Style on theJComponent
fromcontext
.- Parameters:
context
- SynthContext identifying component to install properties to.
-
uninstallDefaults
Uninstalls any state that this style installed on theJComponent
fromcontext
.Styles should NOT depend upon this being called, in certain cases it may never be called.
- Parameters:
context
- SynthContext identifying component to install properties to.
-
getInt
Convenience method to get a specific style property whose value is aNumber
. If the value is aNumber
,intValue
is returned, otherwisedefaultValue
is returned.- Parameters:
context
- SynthContext identifying requesterkey
- Property being requested.defaultValue
- Value to return if the property has not been specified, or is not a Number- Returns:
- Value of the named property
-
getBoolean
Convenience method to get a specific style property whose value is an Boolean.- Parameters:
context
- SynthContext identifying requesterkey
- Property being requested.defaultValue
- Value to return if the property has not been specified, or is not a Boolean- Returns:
- Value of the named property
-
getIcon
Convenience method to get a specific style property whose value is an Icon.- Parameters:
context
- SynthContext identifying requesterkey
- Property being requested.- Returns:
- Value of the named property, or null if not specified
-
getString
Convenience method to get a specific style property whose value is a String.- Parameters:
context
- SynthContext identifying requesterkey
- Property being requested.defaultValue
- Value to return if the property has not been specified, or is not a String- Returns:
- Value of the named property
-