com.softwarefx.chartfx.server

Enum LegendBoxStyles

java.lang.Object

java.lang.Enum<LegendBoxStyles>

com.softwarefx.chartfx.server.LegendBoxStyles

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LegendBoxStyles>

public enum LegendBoxStyles
extends java.lang.Enum<LegendBoxStyles>

Allows you to specify the style for a legend.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIDE_PARTIAL Hides all legends if any of them does not fix in the box.
NO_COLOR No Colors are used for markers in legend.
RIGHT_ALIGN Right aligns the text in the legend.
SHOW_MENU Enables the context menu for the legend.
WORDBREAK Wraps text when the legend alignment is set to spread.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.EnumSet<LegendBoxStyles>	DEFAULT Default legend settings.

Method Summary

Methods

Modifier and Type	Method and Description
int	getUnderlyingValue() Returns a numeric value that represents the given com.softwarefx.chartfx.server.LegendBoxStyles.
static int	getUnderlyingValue(java.util.EnumSet<LegendBoxStyles> value) Returns a numeric value that represents the given com.softwarefx.chartfx.server.LegendBoxStyles.
static LegendBoxStyles	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LegendBoxStyles[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WORDBREAK

public static final LegendBoxStyles WORDBREAK

Wraps text when the legend alignment is set to spread.

SHOW_MENU

public static final LegendBoxStyles SHOW_MENU

Enables the context menu for the legend.

RIGHT_ALIGN

public static final LegendBoxStyles RIGHT_ALIGN

Right aligns the text in the legend. Used with Languages written from right to left.

NO_COLOR

public static final LegendBoxStyles NO_COLOR

No Colors are used for markers in legend.

HIDE_PARTIAL

public static final LegendBoxStyles HIDE_PARTIAL

Hides all legends if any of them does not fix in the box.

Field Detail

DEFAULT

public java.util.EnumSet<LegendBoxStyles> DEFAULT

Default legend settings.

Method Detail

values

public static LegendBoxStyles[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LegendBoxStyles c : LegendBoxStyles.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LegendBoxStyles valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getUnderlyingValue

public int getUnderlyingValue()

Returns a numeric value that represents the given com.softwarefx.chartfx.server.LegendBoxStyles.

getUnderlyingValue

public static int getUnderlyingValue(java.util.EnumSet<LegendBoxStyles> value)

Returns a numeric value that represents the given com.softwarefx.chartfx.server.LegendBoxStyles.

Parameters:

value - A Enum Item.