com.goldencode.p2j.ui

Class ControlSetItem

java.lang.Object

com.goldencode.p2j.ui.ControlSetItem

All Implemented Interfaces:

Printable, java.io.Externalizable, java.io.Serializable

public class ControlSetItem
extends java.lang.Object
implements java.io.Externalizable, Printable

This class is used to transfer pairs (label and corresponding value) between client and server. At client side this class also used to hold values in the configuration.

Version:

1.0.0

Author:

SIY

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	enabled Item is enabled for RADIO-SET
private java.lang.String	format The value's format.
private int	itemId Item id - required for correct restore of the selection after list modification.
private character	label Item label.
private BaseDataType	value Item value.

Constructor Summary

Constructors

Constructor and Description
ControlSetItem() Default constructor
ControlSetItem(character label, BaseDataType value) Constructor for the ControlSetItem instances.
ControlSetItem(int id, character label, BaseDataType value) Constructor for the ControlSetItem instances.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
character	getCharacterValue() Get the character representation of its value.
int	getItemId() Get item id.
character	getLabel() Get item label.
BaseDataType	getValue() Get item value.
int	hashCode()
boolean	isEnabled() Check if item is enabled.
void	print(PrintHelper printer) Print all class-specific fields.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	setEnabled(boolean enabled) Set item 'enabled' flag.
void	setFormat(java.lang.String format) Set the value's format, as reported by getCharacterValue().
void	setItemId(int value) Set item id.
void	setLabel(character label) Set item label.
void	setValue(BaseDataType value) Set item value.
java.lang.String	toString() Returns a string representation of the object.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.util.Printable

asString

Field Detail

itemId

private int itemId

Item id - required for correct restore of the selection after list modification.

label

private character label

Item label.

value

private BaseDataType value

Item value.

enabled

private boolean enabled

Item is enabled for RADIO-SET

format

private java.lang.String format

The value's format.

Constructor Detail

ControlSetItem

public ControlSetItem()

Default constructor

ControlSetItem

public ControlSetItem(int id,
                      character label,
                      BaseDataType value)

Constructor for the ControlSetItem instances.

Parameters:

id - Item id.

label - Item label.

value - Item value.

ControlSetItem

public ControlSetItem(character label,
                      BaseDataType value)

Constructor for the ControlSetItem instances.

Parameters:

label - Item label.

value - Item value.

Method Detail

setFormat

public void setFormat(java.lang.String format)

Set the value's format, as reported by getCharacterValue().

Parameters:

format - The value's format.

getLabel

public character getLabel()

Get item label.

Returns:

Item label.

setLabel

public void setLabel(character label)

Set item label.

Parameters:

label - New item label.

getValue

public BaseDataType getValue()

Get item value.

Returns:

Item value.

setValue

public void setValue(BaseDataType value)

Set item value.

Parameters:

value - New item value.

getItemId

public int getItemId()

Get item id.

Returns:

Item id.

setItemId

public void setItemId(int value)

Set item id.

Parameters:

value - New item id.

isEnabled

public boolean isEnabled()

Check if item is enabled.

Returns:

value of the 'enabled' flag.

setEnabled

public void setEnabled(boolean enabled)

Set item 'enabled' flag.

Parameters:

enabled - New value of item's 'enabled' flag.

getCharacterValue

public character getCharacterValue()

Get the character representation of its value.

Returns:

The character representation of its value, honoring any set format.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

The item hash code

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Returns:

True iff compared items have common label, value and enabled fields.

See Also:

Object.equals(java.lang.Object)

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The latest state is written to the output destination. The parent's state is written first.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The latest state is read from the input source. The parent's state is read first.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

print

public void print(PrintHelper printer)

Print all class-specific fields.

Specified by:

print in interface Printable

Parameters:

printer - the string printer to print into