- java.lang.Object
-
- javax.swing.plaf.synth.SynthStyle
-
- Direct Known Subclasses:
NimbusStyle
public abstract class SynthStyle extends Object
SynthStyleis a set of style properties. EachSynthUIreferences at least oneSynthStylethat is obtained using aSynthStyleFactory. You typically don't need to interact with this class directly, rather you will load a Synth File Format file intoSynthLookAndFeelthat will create a set of SynthStyles.- Since:
- 1.5
- See Also:
SynthLookAndFeel,SynthStyleFactory
-
-
Constructor Summary
Constructors Constructor Description SynthStyle()Constructs a SynthStyle.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Objectget(SynthContext context, Object key)Getter for a region specific style property.booleangetBoolean(SynthContext context, Object key, boolean defaultValue)Convenience method to get a specific style property whose value is an Boolean.ColorgetColor(SynthContext context, ColorType type)Returns the color for the specified state.protected abstract ColorgetColorForState(SynthContext context, ColorType type)Returns the color for the specified state.FontgetFont(SynthContext context)Returns the Font for the specified state.protected abstract FontgetFontForState(SynthContext context)Returns the font for the specified state.SynthGraphicsUtilsgetGraphicsUtils(SynthContext context)Returns theSynthGraphicUtilsfor the specified context.IcongetIcon(SynthContext context, Object key)Convenience method to get a specific style property whose value is an Icon.InsetsgetInsets(SynthContext context, Insets insets)Returns the Insets that are used to calculate sizing information.intgetInt(SynthContext context, Object key, int defaultValue)Convenience method to get a specific style property whose value is aNumber.SynthPaintergetPainter(SynthContext context)Returns theSynthPainterthat will be used for painting.StringgetString(SynthContext context, Object key, String defaultValue)Convenience method to get a specific style property whose value is a String.voidinstallDefaults(SynthContext context)Installs the necessary state from this Style on theJComponentfromcontext.booleanisOpaque(SynthContext context)Returns true if the region is opaque.voiduninstallDefaults(SynthContext context)Uninstalls any state that this style installed on theJComponentfromcontext.
-
-
-
Method Detail
-
getGraphicsUtils
public SynthGraphicsUtils getGraphicsUtils(SynthContext context)
Returns theSynthGraphicUtilsfor the specified context.- Parameters:
context- SynthContext identifying requester- Returns:
- SynthGraphicsUtils
-
getColor
public Color getColor(SynthContext context, ColorType type)
Returns the color for the specified state. This gives precedence to foreground and background of theJComponent. If theColorfrom theJComponentis 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
protected abstract Color getColorForState(SynthContext context, ColorType type)
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
public Font getFont(SynthContext context)
Returns the Font for the specified state. This redirects to theJComponentfrom thecontextas 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
protected abstract Font getFontForState(SynthContext context)
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
public Insets getInsets(SynthContext context, Insets insets)
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
public SynthPainter getPainter(SynthContext context)
Returns theSynthPainterthat will be used for painting. This may return null.- Parameters:
context- SynthContext identifying requester- Returns:
- SynthPainter to use
-
isOpaque
public boolean isOpaque(SynthContext context)
Returns true if the region is opaque.- Parameters:
context- SynthContext identifying requester- Returns:
- true if region is opaque.
-
get
public Object get(SynthContext context, Object key)
Getter for a region specific style property.- Parameters:
context- SynthContext identifying requesterkey- Property being requested.- Returns:
- Value of the named property
-
installDefaults
public void installDefaults(SynthContext context)
Installs the necessary state from this Style on theJComponentfromcontext.- Parameters:
context- SynthContext identifying component to install properties to.
-
uninstallDefaults
public void uninstallDefaults(SynthContext context)
Uninstalls any state that this style installed on theJComponentfromcontext.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
public int getInt(SynthContext context, Object key, int defaultValue)
Convenience method to get a specific style property whose value is aNumber. If the value is aNumber,intValueis returned, otherwisedefaultValueis 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
public boolean getBoolean(SynthContext context, Object key, boolean defaultValue)
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
public Icon getIcon(SynthContext context, Object key)
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
public String getString(SynthContext context, Object key, String defaultValue)
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
-
-