- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
NimbusLookAndFeel
load(java.io.InputStream, java.lang.Class<?>)
method, or provide your own SynthStyleFactory
to setStyleFactory(javax.swing.plaf.synth.SynthStyleFactory)
. Refer to the
package summary for an example of
loading a file, and SynthStyleFactory
for
an example of providing your own SynthStyleFactory
to
setStyleFactory
.
SynthIcon
interface provides
paintIcon(synthContext, graphics, x, y, width, height)
method that
allows to draw the icon with the given SynthContext
.
Warning:
This class implements Serializable
as a side effect of it
extending BasicLookAndFeel
. It is not intended to be serialized.
An attempt to serialize it will
result in NotSerializableException
.
- Since:
- 1.5
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ComponentUI
Creates the Synth look and feelComponentUI
for the passed inJComponent
.Returns the defaults for this SynthLookAndFeel.Returns a textual description of SynthLookAndFeel.getID()
Return a string that identifies this look and feel.getName()
Return a short string that identifies this look and feel.static Region
Returns the Region for the JComponentc
.static SynthStyle
getStyle
(JComponent c, Region region) Gets a SynthStyle for the specified region of the specified component.static SynthStyleFactory
Returns the current SynthStyleFactory.void
Called by UIManager when this look and feel is installed.boolean
Returns false, SynthLookAndFeel is not a native look and feel.boolean
Returns true, SynthLookAndFeel is always supported.void
load
(InputStream input, Class<?> resourceBase) Loads the set ofSynthStyle
s that will be used by thisSynthLookAndFeel
.void
Deprecated, for removal: This API element is subject to removal in a future version.static void
setStyleFactory
(SynthStyleFactory cache) Sets the SynthStyleFactory that the UI classes provided by synth will use to obtain a SynthStyle.boolean
Returns whether or not the UIs should update theirSynthStyles
from theSynthStyleFactory
when the ancestor of theJComponent
changes.protected boolean
Returns whether or not the UIs should update their styles when a particular event occurs.void
Called by UIManager when this look and feel is uninstalled.static void
Updates the style associated withc
, and all its children.Methods declared in class javax.swing.plaf.basic.BasicLookAndFeel
createAudioAction, getAudioActionMap, initClassDefaults, initComponentDefaults, initSystemColorDefaults, loadSystemColors, playSound
Methods declared in class javax.swing.LookAndFeel
getDesktopPropertyValue, getDisabledIcon, getDisabledSelectedIcon, getLayoutStyle, getSupportsWindowDecorations, installBorder, installColors, installColorsAndFont, installProperty, loadKeyBindings, makeComponentInputMap, makeIcon, makeInputMap, makeKeyBindings, provideErrorFeedback, toString, uninstallBorder
-
Constructor Details
-
SynthLookAndFeel
public SynthLookAndFeel()Creates a SynthLookAndFeel.For the returned
SynthLookAndFeel
to be useful you need to invokeload
to specify the set ofSynthStyle
s, or invokesetStyleFactory
.- See Also:
-
-
Method Details
-
setStyleFactory
Sets the SynthStyleFactory that the UI classes provided by synth will use to obtain a SynthStyle.- Parameters:
cache
- SynthStyleFactory the UIs should use.
-
getStyleFactory
Returns the current SynthStyleFactory.- Returns:
- SynthStyleFactory
-
getStyle
Gets a SynthStyle for the specified region of the specified component. This is not for general consumption, only custom UIs should call this method.- Parameters:
c
- JComponent to get the SynthStyle forregion
- Identifies the region of the specified component- Returns:
- SynthStyle to use.
-
updateStyles
Updates the style associated withc
, and all its children. This is a lighter version ofSwingUtilities.updateComponentTreeUI
.- Parameters:
c
- Component to update style for.
-
getRegion
Returns the Region for the JComponentc
.- Parameters:
c
- JComponent to fetch the Region for- Returns:
- Region corresponding to
c
-
createUI
Creates the Synth look and feelComponentUI
for the passed inJComponent
.- Parameters:
c
- JComponent to create theComponentUI
for- Returns:
- ComponentUI to use for
c
-
load
Loads the set ofSynthStyle
s that will be used by thisSynthLookAndFeel
.resourceBase
is used to resolve any path based resources, for example anImage
would be resolved byresourceBase.getResource(path)
. Refer to Synth File Format for more information.- Parameters:
input
- InputStream to load fromresourceBase
- used to resolve any images or other resources- Throws:
ParseException
- if there is an error in parsingIllegalArgumentException
- if input or resourceBase isnull
-
load
@Deprecated(since="21", forRemoval=true) public void load(URL url) throws ParseException, IOException Deprecated, for removal: This API element is subject to removal in a future version.Useload(InputStream, Class)
orsetStyleFactory(SynthStyleFactory)
insteadLoads the set ofSynthStyle
s that will be used by thisSynthLookAndFeel
. Path based resources are resolved relatively to the specifiedURL
of the style. For example anImage
would be resolved bynew URL(synthFile, path)
. Refer to Synth File Format for more information.Whilst this API may be safe for loading local resources that are delivered with a
LookAndFeel
or application, and so have an equal level of trust with application code, using it to load from remote resources, particularly any which may have a lower level of trust, is strongly discouraged. The alternative mechanisms to load styles from anInputStream
load(InputStream, Class) using resources co-located with the application or by providing aSynthStyleFactory
to setStyleFactory(SynthStyleFactory) are preferred. Consequently this method is deprecated and will be removed in a future release.- Parameters:
url
- theURL
to load the set ofSynthStyle
from- Throws:
ParseException
- if there is an error in parsingIllegalArgumentException
- if synthSet isnull
IOException
- if synthSet cannot be opened as anInputStream
- Since:
- 1.6
-
initialize
public void initialize()Called by UIManager when this look and feel is installed.- Overrides:
initialize
in classLookAndFeel
- See Also:
-
uninitialize
public void uninitialize()Called by UIManager when this look and feel is uninstalled.- Overrides:
uninitialize
in classLookAndFeel
- See Also:
-
getDefaults
Returns the defaults for this SynthLookAndFeel.- Overrides:
getDefaults
in classBasicLookAndFeel
- Returns:
- Defaults table.
- See Also:
-
isSupportedLookAndFeel
public boolean isSupportedLookAndFeel()Returns true, SynthLookAndFeel is always supported.- Specified by:
isSupportedLookAndFeel
in classLookAndFeel
- Returns:
- true.
- See Also:
-
isNativeLookAndFeel
public boolean isNativeLookAndFeel()Returns false, SynthLookAndFeel is not a native look and feel.- Specified by:
isNativeLookAndFeel
in classLookAndFeel
- Returns:
- false
-
getDescription
Returns a textual description of SynthLookAndFeel.- Specified by:
getDescription
in classLookAndFeel
- Returns:
- textual description of synth.
-
getName
Return a short string that identifies this look and feel.- Specified by:
getName
in classLookAndFeel
- Returns:
- a short string identifying this look and feel.
-
getID
Return a string that identifies this look and feel.- Specified by:
getID
in classLookAndFeel
- Returns:
- a short string identifying this look and feel.
-
shouldUpdateStyleOnAncestorChanged
public boolean shouldUpdateStyleOnAncestorChanged()Returns whether or not the UIs should update theirSynthStyles
from theSynthStyleFactory
when the ancestor of theJComponent
changes. A subclass that provided aSynthStyleFactory
that based the return value fromgetStyle
off the containment hierarchy would override this method to return true.- Returns:
- whether or not the UIs should update their
SynthStyles
from theSynthStyleFactory
when the ancestor changed.
-
shouldUpdateStyleOnEvent
Returns whether or not the UIs should update their styles when a particular event occurs.- Parameters:
ev
- aPropertyChangeEvent
- Returns:
- whether or not the UIs should update their styles
- Since:
- 1.7
-
load(InputStream, Class)
orsetStyleFactory(SynthStyleFactory)
instead