com.alee.painter.decoration

Interface IDecoration<E extends javax.swing.JComponent,I extends IDecoration<E,I>>

Type Parameters:

E - component type

I - decoration type

All Superinterfaces:

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

All Known Implementing Classes:

AbstractDecoration, WebDecoration

public interface IDecoration<E extends javax.swing.JComponent,I extends IDecoration<E,I>>
extends java.io.Serializable, java.lang.Cloneable, com.alee.api.Mergeable<I>, com.alee.api.Identifiable, PainterShapeProvider<E>

Base interface for component state decorations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STATES_SEPARATOR States separator.

Method Summary

Modifier and Type	Method and Description
java.awt.Insets	getBorderInsets(E c) Returns decoration borders size.
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.
void	paint(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c) Paints component decoration.
void	setSection(boolean section) Sets whether or not this decoration is applied only to a section of the component.

Methods inherited from interface com.alee.api.Mergeable

merge

Methods inherited from interface com.alee.api.Identifiable

getId

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

provideShape

Field Detail

STATES_SEPARATOR

static final java.lang.String STATES_SEPARATOR

States separator.

See Also:

Constant Field Values

Method Detail

getStates

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

Returns component states this decoration is describing.

Returns:

component states this decoration is describing

isVisible

boolean isVisible()

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

Returns:

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

isSection

boolean isSection()

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

Returns:

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

setSection

void setSection(boolean section)

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

Parameters:

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

getBorderInsets

java.awt.Insets getBorderInsets(E c)

Returns decoration borders size.

Parameters:

c - painted component

Returns:

decoration borders size

paint

void paint(java.awt.Graphics2D g2d,
           java.awt.Rectangle bounds,
           E c)

Paints component decoration.

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

getPreferredSize

java.awt.Dimension getPreferredSize()

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

Returns:

decoration preferred size