com.alee.painter.decoration

Class AbstractDecoration<E extends javax.swing.JComponent,I extends AbstractDecoration<E,I>>

java.lang.Object

com.alee.painter.decoration.AbstractDecoration<E,I>

Type Parameters:

E - component type

I - decoration type

All Implemented Interfaces:

com.alee.api.Identifiable, com.alee.api.Mergeable<I>, PainterShapeProvider<E>, IDecoration<E,I>, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

WebDecoration

public abstract class AbstractDecoration<E extends javax.swing.JComponent,I extends AbstractDecoration<E,I>>
extends java.lang.Object
implements IDecoration<E,I>

Abstract component state decoration providing basic settings.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	defaultStateId Default component state ID.
protected java.lang.Float	opacity Decoration opacity.
protected java.lang.Boolean	section Whether or not this decoration is applied only to a section of the component.
protected java.awt.Dimension	size Decoration size.
protected java.util.List<java.lang.String>	states Component states this decoration is describing separated by comma.
protected java.lang.Boolean	visible Whether or not decoration should be displayed.

Fields inherited from interface com.alee.painter.decoration.IDecoration

STATES_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
AbstractDecoration()

Method Summary

Modifier and Type	Method and Description
I	clone()
java.lang.String	getId()
float	getOpacity() Returns decoration opacity.
java.awt.Dimension	getPreferredSize() Returns decoration preferred size.
java.util.List<java.lang.String>	getStates() Returns component states this decoration is describing.
boolean	isSection() Returns whether or not this decoration is applied only to a section of the component.
boolean	isVisible() Returns whether or not this decoration state provides any visible decoration.
I	merge(I state)
void	setSection(boolean section) Sets whether or not this decoration is applied only to a section of the component.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alee.painter.decoration.IDecoration

getBorderInsets, paint

Methods inherited from interface com.alee.managers.style.PainterShapeProvider

provideShape

Field Detail

defaultStateId

public static final java.lang.String defaultStateId

Default component state ID. Added to avoid default state ID being null.

See Also:

Constant Field Values

states

@XStreamAsAttribute
 @XStreamConverter(value=com.alee.utils.xml.ListToStringConverter.class)
protected java.util.List<java.lang.String> states

Component states this decoration is describing separated by comma. Various components might use multiple states to describe their decoration.

visible

@XStreamAsAttribute
protected java.lang.Boolean visible

Whether or not decoration should be displayed. This doesn't affect anything painted outside, for example by any SpecificPainter. In case this decoration is used by SectionPainter this only affects section visibility.

size

@XStreamAsAttribute
protected java.awt.Dimension size

Decoration size. It can be specified to provide fixed decoration size.

opacity

@XStreamAsAttribute
protected java.lang.Float opacity

Decoration opacity. This doesn't affect anything painted outside, for example by any SpecificPainter. In case this decoration is used by SectionPainter this opacity is only applied to the section.

section

protected transient java.lang.Boolean section

Whether or not this decoration is applied only to a section of the component. Provided explicitely by the painted using this decoration.

Constructor Detail

AbstractDecoration

public AbstractDecoration()

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface com.alee.api.Identifiable

getStates

public java.util.List<java.lang.String> getStates()

Description copied from interface: IDecoration

Returns component states this decoration is describing.

Specified by:

getStates in interface IDecoration<E extends javax.swing.JComponent,I extends AbstractDecoration<E,I>>

Returns:

component states this decoration is describing

isVisible

public boolean isVisible()

Description copied from interface: IDecoration

Returns whether or not this decoration state provides any visible decoration.

Specified by:

isVisible in interface IDecoration<E extends javax.swing.JComponent,I extends AbstractDecoration<E,I>>

Returns:

true if this decoration state provides any visible decoration, false otherwise

isSection

public boolean isSection()

Description copied from interface: IDecoration

Returns whether or not this decoration is applied only to a section of the component.

Specified by:

isSection in interface IDecoration<E extends javax.swing.JComponent,I extends AbstractDecoration<E,I>>

Returns:

true if this decoration is applied only to a section of the component, false otherwise

setSection

public void setSection(boolean section)

Description copied from interface: IDecoration

Sets whether or not this decoration is applied only to a section of the component.

Specified by:

setSection in interface IDecoration<E extends javax.swing.JComponent,I extends AbstractDecoration<E,I>>

Parameters:

section - whether or not this decoration is applied only to a section of the component

getOpacity

public float getOpacity()

Returns decoration opacity.

Returns:

decoration opacity

getPreferredSize

public java.awt.Dimension getPreferredSize()

Description copied from interface: IDecoration

Returns decoration preferred size. It is taken into account when decoration preferred size is being calculated.

Specified by:

getPreferredSize in interface IDecoration<E extends javax.swing.JComponent,I extends AbstractDecoration<E,I>>

Returns:

decoration preferred size

merge

public I merge(I state)

Specified by:

merge in interface com.alee.api.Mergeable<I extends AbstractDecoration<E,I>>

clone

public I clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object