ej.mwt.style

Class EditableStyle

java.lang.Object

ej.mwt.style.EditableStyle

All Implemented Interfaces:

Style

public class EditableStyle
extends Object
implements Style

An editable style is a simple implementation of a style. It allows to set all the attributes of a style.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_EXTRA_FIELDS The maximum number of extra fields.

Constructor Summary

Constructors

Constructor and Description
EditableStyle() Creates an editable style from the default style.
EditableStyle(EditableStyle style) Creates an editable style from an other one.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
Background	getBackground() Gets the background.
Outline	getBorder() Gets the border.
int	getColor() Gets the color.
Dimension	getDimension() Gets the dimension.
float	getExtraFloat(int fieldId, float defaultValue) Gets an extra field as a float.
int	getExtraInt(int fieldId, int defaultValue) Gets an extra field as an int.
<T> T	getExtraObject(int fieldId, Class<T> clazz, T defaultValue) Gets an extra field as an object of the given type.
Font	getFont() Gets the font.
int	getHorizontalAlignment() Gets the horizontal alignment.
Outline	getMargin() Gets the margin.
Outline	getPadding() Gets the padding.
int	getVerticalAlignment() Gets the vertical alignment.
int	hashCode() Returns a hash code value for the object.
void	setBackground(Background background) Sets the background.
void	setBorder(Outline border) Sets the border.
void	setColor(int color) Sets the color.
void	setDimension(Dimension dimension) Sets the dimension.
void	setExtraFloat(int fieldId, float fieldValue) Sets an extra field to the given float value.
void	setExtraInt(int fieldId, int fieldValue) Sets an extra field to the given int value.
void	setExtraObject(int fieldId, Object fieldValue) Sets an extra field to the given object value.
void	setFont(Font font) Sets the font.
void	setHorizontalAlignment(int horizontalAlignment) Sets the horizontal alignment.
void	setMargin(Outline margin) Sets the margin.
void	setPadding(Outline padding) Sets the padding.
void	setVerticalAlignment(int verticalAlignment) Sets the vertical alignment.
protected static void	validateExtraFieldId(int fieldId) Validates that the extra field ID is correct.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_EXTRA_FIELDS

public static final int MAX_EXTRA_FIELDS

The maximum number of extra fields.

See Also:

Constant Field Values

Constructor Detail

EditableStyle

public EditableStyle()

Creates an editable style from the default style.

EditableStyle

public EditableStyle(EditableStyle style)

Creates an editable style from an other one.

Parameters:

style - the editable style to copy.

Method Detail

equals

public boolean equals(@Nullable
                      Object obj)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

getBackground

public Background getBackground()

Description copied from interface: Style

Gets the background.

Specified by:

getBackground in interface Style

Returns:

the background.

getBorder

public Outline getBorder()

Description copied from interface: Style

Gets the border.

Specified by:

getBorder in interface Style

Returns:

the border.

getColor

public int getColor()

Description copied from interface: Style

Gets the color.

Specified by:

getColor in interface Style

Returns:

the color.

getDimension

public Dimension getDimension()

Description copied from interface: Style

Gets the dimension.

Specified by:

getDimension in interface Style

Returns:

the dimension.

getExtraFloat

public float getExtraFloat(int fieldId,
                           float defaultValue)

Description copied from interface: Style

Gets an extra field as a float.

Specified by:

getExtraFloat in interface Style

Parameters:

fieldId - the ID of the extra field.

defaultValue - the value to return if the extra field is not set or if it is not a float.

Returns:

the value of the extra field.

getExtraInt

public int getExtraInt(int fieldId,
                       int defaultValue)

Description copied from interface: Style

Gets an extra field as an int.

Specified by:

getExtraInt in interface Style

Parameters:

fieldId - the ID of the extra field.

defaultValue - the value to return if the extra field is not set or if it is not an integer.

Returns:

the value of the extra field.

getExtraObject

public <T> T getExtraObject(int fieldId,
                            Class<T> clazz,
                            T defaultValue)

Description copied from interface: Style

Gets an extra field as an object of the given type.

Specified by:

getExtraObject in interface Style

Type Parameters:

T - the type of the extra field.

Parameters:

fieldId - the ID of the extra field.

clazz - the type of the extra field.

defaultValue - the value to return if the extra field is not set or if it does not match the given type.

Returns:

the value of the extra field.

getFont

public Font getFont()

Description copied from interface: Style

Gets the font.

Specified by:

getFont in interface Style

Returns:

the font.

getHorizontalAlignment

public int getHorizontalAlignment()

Description copied from interface: Style

Gets the horizontal alignment.

Specified by:

getHorizontalAlignment in interface Style

Returns:

the horizontal alignment.

getMargin

public Outline getMargin()

Description copied from interface: Style

Gets the margin.

Specified by:

getMargin in interface Style

Returns:

the margin.

getPadding

public Outline getPadding()

Description copied from interface: Style

Gets the padding.

Specified by:

getPadding in interface Style

Returns:

the padding.

getVerticalAlignment

public int getVerticalAlignment()

Description copied from interface: Style

Gets the vertical alignment.

Specified by:

getVerticalAlignment in interface Style

Returns:

the vertical alignment.

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

setBackground

public void setBackground(Background background)

Sets the background.

Parameters:

background - the background to set.

setBorder

public void setBorder(Outline border)

Sets the border.

Parameters:

border - the border to set.

setColor

public void setColor(int color)

Sets the color.

Parameters:

color - the color to set.

setDimension

public void setDimension(Dimension dimension)

Sets the dimension.

Parameters:

dimension - the dimension to set.

setExtraFloat

public void setExtraFloat(int fieldId,
                          float fieldValue)

Sets an extra field to the given float value.

Parameters:

fieldId - the ID of the extra field to set.

fieldValue - the value of the extra field to set.

Throws:

IllegalArgumentException - if the given ID is not within the [0, 6] interval.

setExtraInt

public void setExtraInt(int fieldId,
                        int fieldValue)

Sets an extra field to the given int value.

Parameters:

fieldId - the ID of the extra field to set.

fieldValue - the value of the extra field to set.

Throws:

IllegalArgumentException - if the given ID is not within the [0, 6] interval.

setExtraObject

public void setExtraObject(int fieldId,
                           Object fieldValue)

Sets an extra field to the given object value.

Parameters:

fieldId - the ID of the extra field to set.

fieldValue - the value of the extra field to set.

Throws:

IllegalArgumentException - if the given ID is not within the [0, 6] interval.

setFont

public void setFont(Font font)

Sets the font.

Parameters:

font - the font to set.

setHorizontalAlignment

public void setHorizontalAlignment(int horizontalAlignment)

Sets the horizontal alignment. The horizontal alignment must be equal to one of the horizontal constants (Alignment.LEFT, Alignment.HCENTER or Alignment.RIGHT).

Parameters:

horizontalAlignment - the horizontal alignment to set.

Throws:

IllegalArgumentException - if the horizontal alignment is not valid.

See Also:

Alignment.validateHorizontalAlignment(int)

setMargin

public void setMargin(Outline margin)

Sets the margin.

Parameters:

margin - the margin to set.

setPadding

public void setPadding(Outline padding)

Sets the padding.

Parameters:

padding - the padding to set.

setVerticalAlignment

public void setVerticalAlignment(int verticalAlignment)

Sets the vertical alignment. The vertical alignment must be equal to one of the vertical constants (Alignment.TOP, Alignment.VCENTER or Alignment.BOTTOM).

Parameters:

verticalAlignment - the vertical alignment to set.

Throws:

IllegalArgumentException - if the vertical alignment is not valid.

See Also:

Alignment.validateVerticalAlignment(int)

validateExtraFieldId

protected static void validateExtraFieldId(int fieldId)

Validates that the extra field ID is correct.

Parameters:

fieldId - the ID to validate.

Throws:

IllegalArgumentException - if the given ID is not within the [0, 6] interval.