BasicLookAndFeel JDK 1.6)

Methods

Hide/Show inherited methods

protected Action createAudioAction (Object key)

Creates and returns an Action used to play a sound.

If key is non-null, an Action is created using the value from the defaults with key key. The value identifies the sound resource to load when actionPerformed is invoked on the Action. The sound resource is loaded into a byte[] by way of getClass().getResourceAsStream().
Returns: an {@code Action} used to play the source, or {@code null} if {@code key} is {@code null}
Parameters:
- key - the key identifying the audio action
Since: 1.4
See Also: BasicLookAndFeel.playSound(Action),

protected ActionMap getAudioActionMap ()

Returns an ActionMap containing the audio actions for this look and feel.

The returned ActionMap contains Actions that embody the ability to render an auditory cue. These auditory cues map onto user and system activities that may be useful for an end user to know about (such as a dialog box appearing).

At the appropriate time, the ComponentUI is responsible for obtaining an Action out of the ActionMap and passing it to playSound.

This method first looks up the ActionMap from the defaults using the key "AuditoryCues.actionMap".

If the value is non-null, it is returned. If the value of the default "AuditoryCues.actionMap" is null and the value of the default "AuditoryCues.cueList" is non-null, an ActionMapUIResource is created and populated. Population is done by iterating over each of the elements of the "AuditoryCues.cueList" array, and invoking createAudioAction() to create an Action for each element. The resulting Action is placed in the ActionMapUIResource, using the array element as the key. For example, if the "AuditoryCues.cueList" array contains a single-element, "audioKey", the ActionMapUIResource is created, then populated by way of actionMap.put(cueList[0], createAudioAction(cueList[0])).

If the value of the default "AuditoryCues.actionMap" is null and the value of the default "AuditoryCues.cueList" is null, an empty ActionMapUIResource is created.
Returns: an ActionMap containing {@code Actions} responsible for playing auditory cues
Throws:
- ClassCastException - if the value of the default {@code "AuditoryCues.actionMap"} is not an {@code ActionMap}, or the value of the default {@code "AuditoryCues.cueList"} is not an {@code Object[]}
Since: 1.4
See Also: BasicLookAndFeel.createAudioAction(java.lang.Object), BasicLookAndFeel.playSound(Action),

public UIDefaults getDefaults () [Overrides LookAndFeel]

Returns the look and feel defaults.

Returns the look and feel defaults. The returned UIDefaults is populated by invoking, in order, initClassDefaults, initSystemColorDefaults and initComponentDefaults.

While this method is public, it should only be invoked by the UIManager when the look and feel is set as the current look and feel and after initialize has been invoked.
Returns: the look and feel defaults
See Also: BasicLookAndFeel.initClassDefaults(javax.swing.UIDefaults), BasicLookAndFeel.initSystemColorDefaults(javax.swing.UIDefaults), BasicLookAndFeel.initComponentDefaults(javax.swing.UIDefaults),

publicabstract String getDescription () [Inherited From LookAndFeel]

Return a one line description of this look and feel implementation, e.g.

publicstatic Object getDesktopPropertyValue (String systemPropertyName, Object fallbackValue) [Inherited From LookAndFeel]

Returns the value of the specified system desktop property by invoking Toolkit.getDefaultToolkit().getDesktopProperty().

Returns the value of the specified system desktop property by
invoking Toolkit.getDefaultToolkit().getDesktopProperty().
If the value of the specified property is null,
fallbackValue is returned.
Returns: the current value of the desktop property
Parameters:
- systemPropertyName - the name of the system desktop property being queried
- fallbackValue - the object to be returned as the value if the system value is null
Since: 1.4
See Also: Toolkit.getDesktopProperty(java.lang.String),

public Icon getDisabledIcon (JComponent component, Icon icon) [Inherited From LookAndFeel]

Returns an Icon with a disabled appearance.

Returns an Icon with a disabled appearance. This method is used to generate a disabled Icon when one has not been specified. For example, if you create a JButton and only specify an Icon via setIcon this method will be called to generate the disabled Icon. If null is passed as icon this method returns null.

Some look and feels might not render the disabled Icon, in which case they will ignore this.
Returns: disabled {@code Icon}, or {@code null} if a suitable {@code Icon} can not be generated
Parameters:
- component - {@code JComponent} that will display the {@code Icon}, may be {@code null}
- icon - {@code Icon} to generate the disabled icon from
Since: 1.5

public Icon getDisabledSelectedIcon (JComponent component, Icon icon) [Inherited From LookAndFeel]

Returns an Icon for use by disabled components that are also selected.

Returns an Icon for use by disabled components that are also selected. This method is used to generate an Icon for components that are in both the disabled and selected states but do not have a specific Icon for this state. For example, if you create a JButton and only specify an Icon via setIcon this method will be called to generate the disabled and selected Icon. If null is passed as icon this methods returns null.

Some look and feels might not render the disabled and selected Icon, in which case they will ignore this.
Returns: disabled and selected icon, or {@code null} if a suitable {@code Icon} can not be generated.
Parameters:
- component - {@code JComponent} that will display the {@code Icon}, may be {@code null}
- icon - {@code Icon} to generate disabled and selected icon from
Since: 1.5

publicabstract String getID () [Inherited From LookAndFeel]

Return a string that identifies this look and feel.

public LayoutStyle getLayoutStyle () [Inherited From LookAndFeel]

Returns the LayoutStyle for this look and feel.

Returns the LayoutStyle for this look and feel. This never returns null.

You generally don't use the LayoutStyle from the look and feel, instead use the LayoutStyle method getInstance.
Returns: the LayoutStyle for this look and feel
Since: 1.6
See Also: LayoutStyle.getInstance(),

publicabstract String getName () [Inherited From LookAndFeel]

Return a short string that identifies this look and feel, e.g.

public boolean getSupportsWindowDecorations () [Inherited From LookAndFeel]

Returns true if the LookAndFeel returned RootPaneUI instances support providing Window decorations in a JRootPane.

The default implementation returns false, subclasses that support Window decorations should override this and return true.
Returns: {@code true} if the {@code RootPaneUI} instances created by this look and feel support client side decorations
Since: 1.4
See Also: JDialog.setDefaultLookAndFeelDecorated(boolean), JFrame.setDefaultLookAndFeelDecorated(boolean), JRootPane.setWindowDecorationStyle(int),

pack-privatestatic Object getUIOfType (ComponentUI ui, Class klass)

Returns the ui that is of type klass, or null if one can not be found.

protected void initClassDefaults (UIDefaults table)

Populates table with mappings from uiClassID to the fully qualified name of the ui class.

Populates table with mappings from uiClassID to the
fully qualified name of the ui class. The value for a
particular uiClassID is "javax.swing.plaf.basic.Basic + uiClassID". For example, the
value for the uiClassID TreeUI is "javax.swing.plaf.basic.BasicTreeUI".
Parameters:
- table - the {@code UIDefaults} instance the entries are added to
Throws:
- NullPointerException - if {@code table} is {@code null}
See Also: LookAndFeel, BasicLookAndFeel.getDefaults(),

protected void initComponentDefaults (UIDefaults table)

Populates table with the defaults for the basic look and feel.

Populates table with the defaults for the basic look and
feel.
Parameters:
- table - the {@code UIDefaults} to add the values to
Throws:
- NullPointerException - if {@code table} is {@code null}

public void initialize () [Overrides LookAndFeel]

Initializes the look and feel.

Initializes the look and feel. While this method is public,
it should only be invoked by the UIManager when a
look and feel is installed as the current look and feel. This
method is invoked before the UIManager invokes
getDefaults. This method is intended to perform any
initialization for the look and feel. Subclasses
should do any one-time setup they need here, rather than
in a static initializer, because look and feel class objects
may be loaded just to discover that isSupportedLookAndFeel()
returns false.

protected void initSystemColorDefaults (UIDefaults table)

Populates table with system colors.

Populates table with system colors. This creates an array of name-color pairs and invokes loadSystemColors.

The name is a String that corresponds to the name of one of the static SystemColor fields in the SystemColor class. A name-color pair is created for every such SystemColor field.

The color corresponds to a hex String as understood by Color.decode. For example, one of the name-color pairs is "desktop"-"#005C5C". This corresponds to the SystemColor field desktop, with a color value of new Color(0x005C5C).

The following shows two of the name-color pairs:

   String[] nameColorPairs = new String[] {
          "desktop", "#005C5C",
    "activeCaption", "#000080" };
   loadSystemColors(table, nameColorPairs, isNativeLookAndFeel());

As previously stated, this invokes loadSystemColors with the supplied table and name-color pair array. The last argument to loadSystemColors indicates whether the value of the field in SystemColor should be used. This method passes the value of isNativeLookAndFeel() as the last argument to loadSystemColors.
Parameters:
- table - the {@code UIDefaults} object the values are added to
Throws:
- NullPointerException - if {@code table} is {@code null}
See Also: SystemColor, BasicLookAndFeel.getDefaults(), BasicLookAndFeel.loadSystemColors(javax.swing.UIDefaults, java.lang.String[], boolean),

pack-privatestatic void installAudioActionMap (ActionMap map)

Sets the parent of the passed in ActionMap to be the audio action map.

pack-private void installAWTEventListener ()

publicstatic void installBorder (JComponent c, String defaultBorderName) [Inherited From LookAndFeel]

Convenience method for setting a component's border property with a value from the defaults.

Convenience method for setting a component's border property with
a value from the defaults. The border is only set if the border is
null or an instance of UIResource.
Parameters:
- c - component to set the border on
- defaultBorderName - key specifying the border
Throws:
- NullPointerException - as described in exceptions

publicstatic void installColors (JComponent c, String defaultBgName, String defaultFgName) [Inherited From LookAndFeel]

Convenience method for setting a component's foreground and background color properties with values from the defaults.

Convenience method for setting a component's foreground
and background color properties with values from the
defaults. The properties are only set if the current
value is either null or a UIResource.
Parameters:
- c - component to set the colors on
- defaultBgName - key for the background
- defaultFgName - key for the foreground
Throws:
- NullPointerException - as described in exceptions
See Also: LookAndFeel.installColorsAndFont(javax.swing.JComponent, java.lang.String, java.lang.String, java.lang.String), UIManager.getColor(java.lang.Object),

publicstatic void installColorsAndFont (JComponent c, String defaultBgName, String defaultFgName, String defaultFontName) [Inherited From LookAndFeel]

Convenience method for setting a component's foreground, background and font properties with values from the defaults.

Convenience method for setting a component's foreground,
background and font properties with values from the
defaults. The properties are only set if the current
value is either null or a UIResource.
Parameters:
- c - component set to the colors and font on
- defaultBgName - key for the background
- defaultFgName - key for the foreground
- defaultFontName - key for the font
Throws:
- NullPointerException - as described in exceptions
See Also: LookAndFeel.installColors(javax.swing.JComponent, java.lang.String, java.lang.String), UIManager.getColor(java.lang.Object), UIManager.getFont(java.lang.Object),

publicstatic void installProperty (JComponent c, String propertyName, Object propertyValue) [Inherited From LookAndFeel]

Convenience method for installing a property with the specified name and value on a component if that property has not already been set by the developer.

Convenience method for installing a property with the specified name
and value on a component if that property has not already been set
by the developer. This method is intended to be used by
ui delegate instances that need to specify a default value for a
property of primitive type (boolean, int, ..), but do not wish
to override a value set by the client. Since primitive property
values cannot be wrapped with the UIResource marker, this method
uses private state to determine whether the property has been set
by the client.
Parameters:
- c - target component to set the property on
- propertyName - name of the property to set
- propertyValue - value of the property
Throws:
- IllegalArgumentException - if the specified property is not one which can be set using this method
- ClassCastException - if the property value has not been set by the developer and the type does not match the property's type
- NullPointerException - if {@code c} is {@code null}, or the named property has not been set by the developer and {@code propertyValue} is {@code null}
Since: 1.5

publicabstract boolean isNativeLookAndFeel () [Inherited From LookAndFeel]

If the underlying platform has a "native" look and feel, and this is an implementation of it, return true.

If the underlying platform has a "native" look and feel, and
this is an implementation of it, return true. For
example, when the underlying platform is Solaris running CDE
a CDE/Motif look and feel implementation would return true.
Returns: {@code true} if this look and feel represents the underlying platform look and feel

publicabstract boolean isSupportedLookAndFeel () [Inherited From LookAndFeel]

Return true if the underlying platform supports and or permits this look and feel.

Return true if the underlying platform supports and or permits
this look and feel. This method returns false if the look
and feel depends on special resources or legal agreements that
aren't defined for the current platform.
Returns: {@code true} if this is a supported look and feel
See Also: UIManager.setLookAndFeel(javax.swing.LookAndFeel),

publicstatic void loadKeyBindings (InputMap retMap, Object keys) [Inherited From LookAndFeel]

Populates an InputMap with the specified bindings.

Populates an InputMap with the specified bindings. The bindings are supplied as a list of alternating keystroke-action key pairs. The keystroke is either an instance of KeyStroke, or a String that identifies the KeyStroke for the binding. Refer to KeyStroke.getKeyStroke(String) for the specific format. The action key part of the pair is the key registered in the InputMap for the KeyStroke.

The following illustrates loading an InputMap with two key-action pairs:

   LookAndFeel.loadKeyBindings(inputMap, new Object[] {
     "control X", "cut",
     "control V", "paste"
   });

Supplying a null list of bindings (keys) does not change retMap in any way.

Specifying a null action key results in removing the keystroke's entry from the InputMap. A null keystroke is ignored.
Parameters:
- retMap - {@code InputMap} to add the {@code key-action} pairs to
- keys - bindings to add to {@code retMap}
Throws:
- NullPointerException - if {@code keys} is {@code non-null}, not empty, and {@code retMap} is {@code null}
Since: 1.3
See Also: KeyStroke.getKeyStroke(String), InputMap,

protected void loadSystemColors (UIDefaults table, String systemColors, boolean useNative)

Populates table with the name-color pairs in systemColors.

Populates table with the name-color pairs in systemColors. Refer to BasicLookAndFeel.initSystemColorDefaults(UIDefaults) for details on the format of systemColors.

An entry is added to table for each of the name-color pairs in systemColors. The entry key is the name of the name-color pair.

The value of the entry corresponds to the color of the name-color pair. The value of the entry is calculated in one of two ways. With either approach the value is always a ColorUIResource.

If useNative is false, the color is created by using Color.decode to convert the String into a Color. If decode can not convert the String into a Color (NumberFormatException is thrown) then a ColorUIResource of black is used.

If useNative is true, the color is the value of the field in SystemColor with the same name as the name of the name-color pair. If the field is not valid, a ColorUIResource of black is used.
Parameters:
- table - the {@code UIDefaults} object the values are added to
- systemColors - array of {@code name-color} pairs as described in {@link #initSystemColorDefaults(UIDefaults)}
- useNative - whether the color is obtained from {@code SystemColor} or {@code Color.decode}
Throws:
- NullPointerException - if {@code systemColors} is {@code null}; or {@code systemColors} is not empty, and {@code table} is {@code null}; or one of the names of the {@code name-color} pairs is {@code null}; or {@code useNative} is {@code false} and one of the {@code colors} of the {@code name-color} pairs is {@code null}
- ArrayIndexOutOfBoundsException - if {@code useNative} is {@code false} and {@code systemColors.length} is odd
See Also: BasicLookAndFeel.initSystemColorDefaults(javax.swing.UIDefaults), SystemColor, Color.decode(String),

publicstatic ComponentInputMap makeComponentInputMap (JComponent c, Object keys) [Inherited From LookAndFeel]

Creates a ComponentInputMapUIResource from keys.

Creates a ComponentInputMapUIResource from
keys. This is a convenience method for creating a
new ComponentInputMapUIResource, invoking loadKeyBindings(map, keys), and returning the ComponentInputMapUIResource.
Returns: newly created and populated {@code InputMapUIResource}
Parameters:
- c - component to create the {@code ComponentInputMapUIResource} with
- keys - alternating pairs of {@code keystroke-action key} pairs as described in {@link #loadKeyBindings}
Throws:
- IllegalArgumentException - if {@code c} is {@code null}
Since: 1.3
See Also: LookAndFeel.loadKeyBindings(javax.swing.InputMap, java.lang.Object[]), ComponentInputMapUIResource,

publicstatic Object makeIcon (Class<Object> baseClass, String gifFile) [Inherited From LookAndFeel]

Creates and returns a UIDefault.LazyValue that loads an image.

Creates and returns a UIDefault.LazyValue that loads an image. The returned value is an implementation of UIDefaults.LazyValue. When createValue is invoked on the returned object, the image is loaded. If the image is non-null, it is then wrapped in an Icon that implements UIResource. The image is loaded using Class.getResourceAsStream(gifFile).

This method does not check the arguments in any way. It is strongly recommended that non-null values are supplied else exceptions may occur when createValue is invoked on the returned object.
Returns: a {@code UIDefaults.LazyValue}; when resolved the {@code LazyValue} loads the specified image
Parameters:
- baseClass - {@code Class} used to load the resource
- gifFile - path to the image to load
See Also: UIDefaults.LazyValue, Icon, Class.getResourceAsStream(String),

publicstatic InputMap makeInputMap (Object keys) [Inherited From LookAndFeel]

Creates a InputMapUIResource from keys.

Creates a InputMapUIResource from keys. This is
a convenience method for creating a new InputMapUIResource,
invoking loadKeyBindings(map, keys), and returning the
InputMapUIResource.
Returns: newly created and populated {@code InputMapUIResource}
Parameters:
- keys - alternating pairs of {@code keystroke-action key} pairs as described in {@link #loadKeyBindings}
Since: 1.3
See Also: LookAndFeel.loadKeyBindings(javax.swing.InputMap, java.lang.Object[]),

publicstatic KeyBinding makeKeyBindings (Object keyBindingList) [Inherited From LookAndFeel]

Convenience method for building an array of KeyBindings.

Convenience method for building an array of KeyBindings. While this method is not deprecated, developers should instead use ActionMap and InputMap for supplying key bindings.

This method returns an array of KeyBindings, one for each alternating key-action pair in keyBindingList. A key can either be a String in the format specified by the KeyStroke.getKeyStroke method, or a KeyStroke. The action part of the pair is a String that corresponds to the name of the Action.

The following example illustrates creating a KeyBinding array from six alternating key-action pairs:

        JTextComponent.KeyBinding[] multilineBindings = makeKeyBindings( new Object[] {
          "UP", DefaultEditorKit.upAction,
        "DOWN", DefaultEditorKit.downAction,
     "PAGE_UP", DefaultEditorKit.pageUpAction,
   "PAGE_DOWN", DefaultEditorKit.pageDownAction,
       "ENTER", DefaultEditorKit.insertBreakAction,
         "TAB", DefaultEditorKit.insertTabAction
  });

If keyBindingList's length is odd, the last element is ignored.

Supplying a null value for either the key or action part of the key-action pair results in creating a KeyBinding with the corresponding value null. As other parts of Swing's expect non-null values in a KeyBinding, you should avoid supplying null as either the key or action part of the key-action pair.
Returns: an array of {@code KeyBindings}
Parameters:
- keyBindingList - an array of {@code key-action} pairs
Throws:
- NullPointerException - if {@code keyBindingList} is {@code null}
- ClassCastException - if the {@code key} part of the pair is not a {@code KeyStroke} or {@code String}, or the {@code action} part of the pair is not a {@code String}
See Also: ActionMap, InputMap, KeyStroke.getKeyStroke(char),

protected void playSound (Action audioAction)

If necessary, invokes actionPerformed on audioAction to play a sound.

If necessary, invokes actionPerformed on
audioAction to play a sound.
The actionPerformed method is invoked if the value of
the "AuditoryCues.playList" default is a non-null Object[] containing a String entry
equal to the name of the audioAction.
Parameters:
- audioAction - an Action that knows how to render the audio associated with the system or user activity that is occurring; a value of {@code null}, is ignored
Throws:
- ClassCastException - if {@code audioAction} is {@code non-null} and the value of the default {@code "AuditoryCues.playList"} is not an {@code Object[]}
Since: 1.4

pack-privatestatic void playSound (JComponent c, Object actionKey)

Helper method to play a named sound.

public void provideErrorFeedback (Component component) [Inherited From LookAndFeel]

Invoked when the user attempts an invalid operation, such as pasting into an uneditable JTextField that has focus.

Invoked when the user attempts an invalid operation,
such as pasting into an uneditable JTextField
that has focus. The default implementation beeps. Subclasses
that wish different behavior should override this and provide
the additional feedback.
Parameters:
- component - the Component the error occurred in, may be null indicating the error condition is not directly associated with a Component
Since: 1.4

public String toString () [Inherited From LookAndFeel]

Returns a string that displays and identifies this object's properties.

public void uninitialize () [Overrides LookAndFeel]

Uninitializes the look and feel.

Uninitializes the look and feel. While this method is public, it should only be invoked by the UIManager when the look and feel is uninstalled. For example, UIManager.setLookAndFeel invokes this when the look and feel is changed.

Subclasses may choose to free up some resources here.

publicstatic void uninstallBorder (JComponent c) [Inherited From LookAndFeel]

Convenience method for uninstalling a border.

Convenience method for uninstalling a border. If the border of
the component is a UIResource, it is set to null.
Parameters:
- c - component to uninstall the border on
Throws:
- NullPointerException - if {@code c} is {@code null}