com.alee.painter.decoration.shape

Class Sides

java.lang.Object

com.alee.painter.decoration.shape.Sides

All Implemented Interfaces:

CloneBehavior<Sides>, Mergeable, Overwriting, Serializable, Cloneable

@XStreamConverter(value=SidesConverter.class)
public final class Sides
extends Object
implements Overwriting, CloneBehavior<Sides>, Serializable

Sides display states. In XML it can be represented in three multiple ways: 1. Integer values Displayed side: "1" Hidden side: "0" Examples: "1,0,1,0" or "1,0,1" or "1,0" or "0" 2. Boolean values Displayed side: "true" Hidden side: "false" Examples: "true,false,true,false" or "true,false,true" or "true,false" or "false" 3. Text values Displayed side: "top", "left", "bottom", "right" Hidden side: side not specified Examples: "top,left,bottom,right" or "top,left,bottom" or "top,right" or "bottom"

Author:

Mikle Garin

See Also:

SidesConverter, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bottom Whether or not botton (south) side should be displayed.
static String	BOTTOM
boolean	left Whether or not left (west) side should be displayed.
static String	LEFT
static String	NONE
boolean	right Whether or not right (east) side should be displayed.
static String	RIGHT
boolean	top Whether or not top (north) side should be displayed.
static String	TOP Sides constants.

Constructor Summary

Constructors

Constructor and Description
Sides() Constructs sides display settings.
Sides(boolean display) Constructs sides display settings.
Sides(boolean topBottom, boolean leftRight) Constructs sides display settings.
Sides(boolean top, boolean leftRight, boolean bottom) Constructs sides display settings.
Sides(boolean top, boolean left, boolean bottom, boolean right) Constructs sides display settings.

Method Summary

Modifier and Type	Method and Description
Sides	clone(RecursiveClone clone, int depth)
boolean	isAny() Returns whether or not at least one side should be displayed.
boolean	isOverwrite()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TOP

public static final String TOP

Sides constants.

See Also:

Constant Field Values

LEFT

public static final String LEFT

See Also:

Constant Field Values

BOTTOM

public static final String BOTTOM

See Also:

Constant Field Values

RIGHT

public static final String RIGHT

See Also:

Constant Field Values

NONE

public static final String NONE

See Also:

Constant Field Values

top

public final boolean top

Whether or not top (north) side should be displayed.

left

public final boolean left

Whether or not left (west) side should be displayed.

bottom

public final boolean bottom

Whether or not botton (south) side should be displayed.

right

public final boolean right

Whether or not right (east) side should be displayed.

Constructor Detail

Sides

public Sides()

Constructs sides display settings.

Sides

public Sides(boolean display)

Constructs sides display settings.

Parameters:

display - whether or not all sides should be displayed

Sides

public Sides(boolean topBottom,
             boolean leftRight)

Constructs sides display settings.

Parameters:

topBottom - whether or not top and bottom sides should be displayed

leftRight - whether or not left and right sides should be displayed

Sides

public Sides(boolean top,
             boolean leftRight,
             boolean bottom)

Constructs sides display settings.

Parameters:

top - whether or not top side should be displayed

leftRight - whether or not left and right sides should be displayed

bottom - whether or not bottom side should be displayed

Sides

public Sides(boolean top,
             boolean left,
             boolean bottom,
             boolean right)

Constructs sides display settings.

Parameters:

top - whether or not top side should be displayed

left - whether or not left side should be displayed

bottom - whether or not bottom side should be displayed

right - whether or not right side should be displayed

Method Detail

isAny

public boolean isAny()

Returns whether or not at least one side should be displayed.

Returns:

true if at least one side should be displayed, false otherwise

isOverwrite

public boolean isOverwrite()

Specified by:

isOverwrite in interface Overwriting

clone

@NotNull
public Sides clone(@NotNull
                            RecursiveClone clone,
                            int depth)

Specified by:

clone in interface CloneBehavior<Sides>

toString

@NotNull
public String toString()

Overrides:

toString in class Object