org.eth.cyril.settings

Class LayoutSetting

java.lang.Object

org.eth.cyril.settings.LayoutSetting

All Implemented Interfaces:

Setting, Validator

public class LayoutSetting
extends java.lang.Object
implements Setting

A LayoutSetting represents either a weight or a distance to be used for ordering or positioning in layout.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eth.cyril.settings.Setting

Setting.DataType

Constructor Summary

Constructors

Constructor and Description
LayoutSetting(java.lang.String type, java.lang.String arg, java.lang.String name, java.lang.String tooltip)

Method Summary

Modifier and Type	Method and Description
void	apply(java.lang.Object input) Applies the given input to this setting.
java.lang.Object	getCurrentValue() Gets the initial, current value of this setting.
Setting.DataType	getDataType() The data type which this setting represents.
java.lang.String	getId() The ID of this setting to uniquely identify the setting.
java.lang.String	getName() Gets the name to display this setting with.
java.lang.String	getTooltip() Gets the tooltip to offer more information for this setting.
boolean	requiresRestart() Returns whether changing this setting requires a restart to be performed, in order for the setting to become active.
boolean	validate(java.lang.Object input)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eth.cyril.settings.Setting

getSelection

Constructor Detail

LayoutSetting

public LayoutSetting(java.lang.String type,
                     java.lang.String arg,
                     java.lang.String name,
                     java.lang.String tooltip)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Setting

The ID of this setting to uniquely identify the setting.

Specified by:

getId in interface Setting

Returns:

Unique ID of the setting.

getDataType

public Setting.DataType getDataType()

Description copied from interface: Setting

The data type which this setting represents.

Specified by:

getDataType in interface Setting

Returns:

The data type represented by this setting.

getCurrentValue

public java.lang.Object getCurrentValue()

Description copied from interface: Setting

Gets the initial, current value of this setting. The value must be of the type denoted by the given data type.

Specified by:

getCurrentValue in interface Setting

Returns:

The initial, current value of this setting.

getName

public java.lang.String getName()

Description copied from interface: Setting

Gets the name to display this setting with.

Specified by:

getName in interface Setting

Returns:

The name to display this setting with.

getTooltip

public java.lang.String getTooltip()

Description copied from interface: Setting

Gets the tooltip to offer more information for this setting. This method may return null.

Specified by:

getTooltip in interface Setting

Returns:

The tooltip to offer more information, or null.

apply

public void apply(java.lang.Object input)

Description copied from interface: Setting

Applies the given input to this setting. The input is ensured to either be the current value, or one that validated successfully for this setting. Setting this input to null removes the setting, and will therefore apply its default value.

Specified by:

apply in interface Setting

Parameters:

input - The input. It is either the current value of the setting, or validated successfully.

validate

public boolean validate(java.lang.Object input)

Specified by:

validate in interface Validator

requiresRestart

public boolean requiresRestart()

Description copied from interface: Setting

Returns whether changing this setting requires a restart to be performed, in order for the setting to become active.

Specified by:

requiresRestart in interface Setting

Returns:

Whether changing this setting requires a restart to be performed.