com.alee.managers.style
Enum SupportedComponent

java.lang.Object
  java.lang.Enum<SupportedComponent>
      com.alee.managers.style.SupportedComponent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SupportedComponent>

public enum SupportedComponent
extends java.lang.Enum<SupportedComponent>

This enumeration represents list of Swing and WebLaF components which support WebLaF styling. It also contains some references and useful settings for each component type.

Author:

Mikle Garin

See Also:

How to use StyleManager, StyleManager, WebLookAndFeel

Enum Constant Summary

button
Button-related components.

checkBox

checkBoxMenuItem

colorChooser
Chooser components.

comboBox

desktopIcon

desktopPane
Desktop-pane-related components.

editorPane

fileChooser

formattedTextField

internalFrame

label
Label-related components.

list

menu

menuBar
Menu-related components.

menuItem

multiLineLabel

optionPane
Option pane component.

panel
Container-related components.

passwordField

popupMenu

popupMenuSeparator

progressBar
Other data-related components.

radioButton

radioButtonMenuItem

rootPane

scrollBar
Scroll-related components.

scrollPane

separator
Separator component.

slider

spinner

splitButton

splitPane

tabbedPane

table
Table-related components.

tableHeader

textArea

textField
Text-related components.

textPane

toggleButton

toolBar
Toolbar-related components.

toolBarSeparator

toolTip

tree

tristateCheckBox

verticalLabel

viewport

Field Summary

protected java.lang.Class<? extends javax.swing.JComponent>	componentClass
protected java.lang.String	defaultUIClass
protected boolean	supportsPainters Enum constant settings.
protected java.lang.String	uiClassID

Method Summary

java.lang.Class<? extends javax.swing.JComponent>	getComponentClass() Returns component class for this component type.
java.lang.String	getComponentStyleId(javax.swing.JComponent component) Returns style identifier for the specified component.
static SupportedComponent	getComponentTypeByUIClassID(java.lang.String uiClassID) Returns supported component type by UI class ID.
java.lang.String	getDefaultUIClass() Returns default UI class canonical name.
javax.swing.ImageIcon	getIcon() Returns component type icon.
static java.util.List<SupportedComponent>	getPainterSupportedComponents() Returns list of component types which supports painters.
java.lang.Class<? extends javax.swing.plaf.ComponentUI>	getUIClass() Returns UI class for this component type.
java.lang.String	getUIClassID() Returns UI class ID used by LookAndFeel to store various settings.
boolean	supportsPainters() Returns whether this component type supports painters or not.
static SupportedComponent	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SupportedComponent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

label

public static final SupportedComponent label

Label-related components.

verticalLabel

public static final SupportedComponent verticalLabel

multiLineLabel

public static final SupportedComponent multiLineLabel

toolTip

public static final SupportedComponent toolTip

button

public static final SupportedComponent button

Button-related components.

splitButton

public static final SupportedComponent splitButton

toggleButton

public static final SupportedComponent toggleButton

checkBox

public static final SupportedComponent checkBox

tristateCheckBox

public static final SupportedComponent tristateCheckBox

radioButton

public static final SupportedComponent radioButton

menuBar

public static final SupportedComponent menuBar

Menu-related components.

menu

public static final SupportedComponent menu

popupMenu

public static final SupportedComponent popupMenu

menuItem

public static final SupportedComponent menuItem

checkBoxMenuItem

public static final SupportedComponent checkBoxMenuItem

radioButtonMenuItem

public static final SupportedComponent radioButtonMenuItem

popupMenuSeparator

public static final SupportedComponent popupMenuSeparator

separator

public static final SupportedComponent separator

Separator component.

scrollBar

public static final SupportedComponent scrollBar

Scroll-related components.

scrollPane

public static final SupportedComponent scrollPane

viewport

public static final SupportedComponent viewport

textField

public static final SupportedComponent textField

Text-related components.

passwordField

public static final SupportedComponent passwordField

formattedTextField

public static final SupportedComponent formattedTextField

textArea

public static final SupportedComponent textArea

editorPane

public static final SupportedComponent editorPane

textPane

public static final SupportedComponent textPane

toolBar

public static final SupportedComponent toolBar

Toolbar-related components.

toolBarSeparator

public static final SupportedComponent toolBarSeparator

table

public static final SupportedComponent table

Table-related components.

tableHeader

public static final SupportedComponent tableHeader

colorChooser

public static final SupportedComponent colorChooser

Chooser components.

fileChooser

public static final SupportedComponent fileChooser

panel

public static final SupportedComponent panel

Container-related components.

rootPane

public static final SupportedComponent rootPane

tabbedPane

public static final SupportedComponent tabbedPane

splitPane

public static final SupportedComponent splitPane

progressBar

public static final SupportedComponent progressBar

Other data-related components.

slider

public static final SupportedComponent slider

spinner

public static final SupportedComponent spinner

tree

public static final SupportedComponent tree

list

public static final SupportedComponent list

comboBox

public static final SupportedComponent comboBox

desktopPane

public static final SupportedComponent desktopPane

Desktop-pane-related components.

desktopIcon

public static final SupportedComponent desktopIcon

internalFrame

public static final SupportedComponent internalFrame

optionPane

public static final SupportedComponent optionPane

Option pane component.

Field Detail

supportsPainters

protected final boolean supportsPainters

Enum constant settings.

componentClass

protected final java.lang.Class<? extends javax.swing.JComponent> componentClass

uiClassID

protected final java.lang.String uiClassID

defaultUIClass

protected final java.lang.String defaultUIClass

Method Detail

values

public static SupportedComponent[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SupportedComponent c : SupportedComponent.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SupportedComponent valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

supportsPainters

public boolean supportsPainters()

Returns whether this component type supports painters or not.

Returns:

true if this component type supports painters, false otherwise

getComponentClass

public java.lang.Class<? extends javax.swing.JComponent> getComponentClass()

Returns component class for this component type.

Returns:

component class for this component type

getUIClassID

public java.lang.String getUIClassID()

Returns UI class ID used by LookAndFeel to store various settings.

Returns:

UI class ID

getDefaultUIClass

public java.lang.String getDefaultUIClass()

Returns default UI class canonical name. This value is used in WebLookAndFeel to provide default UI classes. However they can be reassigned before WebLookAndFeel installation.

Returns:

default UI class canonical name

getComponentStyleId

public java.lang.String getComponentStyleId(javax.swing.JComponent component)

Returns style identifier for the specified component. This identifier might be customized in component to force StyleManager provide another style for that specific component.

Returns:

component identifier used within style in skin descriptor

getUIClass

public java.lang.Class<? extends javax.swing.plaf.ComponentUI> getUIClass()

Returns UI class for this component type. Result of this method is not cached because UI classes might be changed in runtime.

Returns:

UI class for this component type

getIcon

public javax.swing.ImageIcon getIcon()

Returns component type icon.

Returns:

component type icon

getComponentTypeByUIClassID

public static SupportedComponent getComponentTypeByUIClassID(java.lang.String uiClassID)

Returns supported component type by UI class ID.

Parameters:

uiClassID - UI class ID

Returns:

supported component type by UI class ID

getPainterSupportedComponents

public static java.util.List<SupportedComponent> getPainterSupportedComponents()

Returns list of component types which supports painters.

Returns:

list of component types which supports painters