com.alee.managers.style.data

Class ComponentStyle

java.lang.Object

com.alee.managers.style.data.ComponentStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

@XStreamConverter(value=ComponentStyleConverter.class)
public final class ComponentStyle
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Component style information class.

See Also:

How to use StyleManager, StyleManager, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_PAINTER_ID Base painter ID.

Constructor Summary

Constructors

Constructor and Description
ComponentStyle() Constructs new component style information.

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	appendEmptyUIProperties(javax.swing.plaf.ComponentUI ui, java.util.Map<java.lang.String,java.lang.Object> uiProperties) Appends empty property values if required.
boolean	apply(javax.swing.JComponent component) Applies this style to the specified component.
ComponentStyle	clone() Returns cloned instance of this component style.
PainterStyle	getBasePainter() Returns component base painter.
java.lang.String	getCompleteId() Returns complete style ID.
java.util.Map<java.lang.String,java.lang.Object>	getComponentProperties() Returns component properties.
java.lang.String	getExtendsId() Returns extended component style ID or null if none extended.
static <T> T	getFieldValue(java.lang.Object object, java.lang.String field) Returns object field value.
java.lang.String	getId() Returns component style ID.
<T extends Painter> T	getPainter(javax.swing.JComponent component) Returns actual painter used within specified component.
<T extends Painter> T	getPainter(javax.swing.JComponent component, java.lang.String painterId) Returns actual painter used within specified component.
java.util.List<PainterStyle>	getPainters() Returns component painters.
ComponentStyle	getParent() Returns parent component style.
java.util.List<ComponentStyle>	getStyles() Returns nested styles list.
int	getStylesCount() Returns nested styles count.
StyleableComponent	getType() Returns supported component type.
java.util.Map<java.lang.String,java.lang.Object>	getUIProperties() Returns component UI properties.
protected void	installPainter(java.lang.Object object, javax.swing.JComponent component, boolean customizable, PainterStyle painterStyle) Installs painter into specified object based on provided painter style.
ComponentStyle	merge(ComponentStyle style) Merges specified style on top of this style.
boolean	remove(javax.swing.JComponent component) Removes this style from the specified component.
ComponentStyle	setComponentProperties(java.util.Map<java.lang.String,java.lang.Object> componentProperties) Sets component properties.
ComponentStyle	setExtendsId(java.lang.String id) Sets extended component style ID.
ComponentStyle	setId(java.lang.String id) Sets component style ID.
ComponentStyle	setPainters(java.util.List<PainterStyle> painters) Sets component painters.
ComponentStyle	setParent(ComponentStyle parent) Sets parent component style.
ComponentStyle	setStyles(java.util.List<ComponentStyle> styles) Sets nested styles list.
ComponentStyle	setType(StyleableComponent type) Sets supported component type.
ComponentStyle	setUIProperties(java.util.Map<java.lang.String,java.lang.Object> uiProperties) Sets component UI properties
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BASE_PAINTER_ID

public static final java.lang.String BASE_PAINTER_ID

Base painter ID.

See Also:

Constant Field Values

Constructor Detail

ComponentStyle

public ComponentStyle()

Constructs new component style information.

Method Detail

getType

public StyleableComponent getType()

Returns supported component type.

Returns:

supported component type

setType

public ComponentStyle setType(StyleableComponent type)

Sets supported component type.

Parameters:

type - new supported component type

Returns:

this style

getId

public java.lang.String getId()

Returns component style ID.

Returns:

component style ID

getCompleteId

public java.lang.String getCompleteId()

Returns complete style ID.

Returns:

complete style ID

setId

public ComponentStyle setId(java.lang.String id)

Sets component style ID.

Parameters:

id - new component style ID

Returns:

this style

getExtendsId

public java.lang.String getExtendsId()

Returns extended component style ID or null if none extended.

Returns:

extended component style ID or null if none extended

setExtendsId

public ComponentStyle setExtendsId(java.lang.String id)

Sets extended component style ID. Set this to null in case you don't want to extend any style.

Parameters:

id - new extended component style ID

Returns:

this style

getComponentProperties

public java.util.Map<java.lang.String,java.lang.Object> getComponentProperties()

Returns component properties.

Returns:

component properties

setComponentProperties

public ComponentStyle setComponentProperties(java.util.Map<java.lang.String,java.lang.Object> componentProperties)

Sets component properties.

Parameters:

componentProperties - new component properties

Returns:

this style

getUIProperties

public java.util.Map<java.lang.String,java.lang.Object> getUIProperties()

Returns component UI properties.

Returns:

component UI properties

setUIProperties

public ComponentStyle setUIProperties(java.util.Map<java.lang.String,java.lang.Object> uiProperties)

Sets component UI properties

Parameters:

uiProperties - new component UI properties

Returns:

this style

getPainters

public java.util.List<PainterStyle> getPainters()

Returns component painters.

Returns:

component painters

setPainters

public ComponentStyle setPainters(java.util.List<PainterStyle> painters)

Sets component painters.

Parameters:

painters - new component painters

Returns:

this style

getBasePainter

public PainterStyle getBasePainter()

Returns component base painter.

Returns:

component base painter

getStyles

public java.util.List<ComponentStyle> getStyles()

Returns nested styles list.

Returns:

nested styles list

getStylesCount

public int getStylesCount()

Returns nested styles count.

Returns:

nested styles count

setStyles

public ComponentStyle setStyles(java.util.List<ComponentStyle> styles)

Sets nested styles list.

Parameters:

styles - nested styles list

Returns:

this style

getParent

public ComponentStyle getParent()

Returns parent component style.

Returns:

parent component style

setParent

public ComponentStyle setParent(ComponentStyle parent)

Sets parent component style.

Parameters:

parent - parent component style

Returns:

this style

apply

public boolean apply(javax.swing.JComponent component)

Applies this style to the specified component. Returns whether style was successfully applied or not.

Parameters:

component - component to apply style to

Returns:

true if style was applied, false otherwise

installPainter

protected void installPainter(java.lang.Object object,
                              javax.swing.JComponent component,
                              boolean customizable,
                              PainterStyle painterStyle)
                       throws java.lang.NoSuchFieldException,
                              java.lang.NoSuchMethodException,
                              java.lang.reflect.InvocationTargetException,
                              java.lang.IllegalAccessException

Installs painter into specified object based on provided painter style.

Parameters:

object - object to install painter into

component - component painter is installed for

customizable - whether or not this painter customizable through StyleManager

painterStyle - painter style

Throws:

java.lang.NoSuchFieldException - if painter could not be set into object

java.lang.NoSuchMethodException - if painter setter method could not be found

java.lang.reflect.InvocationTargetException - if painter setter method invocation failed

java.lang.IllegalAccessException - if painter setter method is not accessible

appendEmptyUIProperties

protected java.util.Map<java.lang.String,java.lang.Object> appendEmptyUIProperties(javax.swing.plaf.ComponentUI ui,
                                                                                   java.util.Map<java.lang.String,java.lang.Object> uiProperties)

Appends empty property values if required.

Parameters:

ui - component UI

uiProperties - properties

Returns:

modified properties map

remove

public boolean remove(javax.swing.JComponent component)

Removes this style from the specified component.

Parameters:

component - component to remove style from

Returns:

true if style was successfully removed, false otherwise

getPainter

public <T extends Painter> T getPainter(javax.swing.JComponent component)

Returns actual painter used within specified component.

Type Parameters:

T - painter type

Parameters:

component - component to retrieve painter from

Returns:

actual painter used within specified component

getPainter

public <T extends Painter> T getPainter(javax.swing.JComponent component,
                                        java.lang.String painterId)

Returns actual painter used within specified component.

Type Parameters:

T - painter type

Parameters:

component - component to retrieve painter from

painterId - painter ID

Returns:

actual painter used within specified component

getFieldValue

public static <T> T getFieldValue(java.lang.Object object,
                                  java.lang.String field)

Returns object field value. This method allows to access even private object fields. Note that this method might also work even if there is no real field with the specified name but there is fitting getter method.

Type Parameters:

T - value type

Parameters:

object - object instance

field - object field

Returns:

field value for the specified object or null

merge

public ComponentStyle merge(ComponentStyle style)

Merges specified style on top of this style.

Parameters:

style - style to merge on top of this one

Returns:

merge result

clone

public ComponentStyle clone()

Returns cloned instance of this component style.

Overrides:

clone in class java.lang.Object

Returns:

cloned instance of this component style

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object