com.canto.cumulus.fieldvalue

Class LabelFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.LabelFieldValue

All Implemented Interfaces:

FieldValue

public class LabelFieldValue
extends java.lang.Object
implements FieldValue

A field value wrapper for a "Label" field. This field type is actually a field value interpretation for a basic field type of "String List". Use Item.getLabelValue(com.canto.cumulus.GUID) to get this wrapper class object. You can then use Item.setLabelValue(com.canto.cumulus.GUID, LabelFieldValue) to set the field value back into the item.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
LabelFieldValue(FieldDefinition fieldDefinition) Creates a new instance for the given label field.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearValue() Clear the field's value.
int	getColor() Get the color value for this label field value.
java.lang.String	getDisplayString() Return a string representation for the color of this label.
java.lang.String	getDisplayString(java.util.Locale locale) Return a string representation for the color of this label.
int	getID() Because a "Label" field is a value interpretation of a string list field this method allows you to get down to the ID of the string list value.
boolean	hasValue() Return whether this field has a value.
void	setColor(int color) Set the label field value from a color value.
void	setFromDisplayString(java.util.Locale locale, java.lang.String value) Set the label field value from a string representation of the color.
void	setFromDisplayString(java.lang.String value) Set the label field value from a string representation of the color.
void	setID(int enumID) Because a "Label" field is a value interpretation of a string list field this method allows you to set the field value using the ID of the underlying string list value.
java.lang.String	toString() Same as getDisplayString().

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LabelFieldValue

public LabelFieldValue(FieldDefinition fieldDefinition)

Creates a new instance for the given label field.

Parameters:

fieldDefinition - label field

Since:

8.5.1

Method Detail

hasValue

public boolean hasValue()

Return whether this field has a value.

Specified by:

hasValue in interface FieldValue

Returns:

true if the field has a value, false otherwise.

clearValue

public void clearValue()

Clear the field's value. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.

Specified by:

clearValue in interface FieldValue

getDisplayString

public java.lang.String getDisplayString()

Return a string representation for the color of this label. The string is formatted according to the HTML specification using "#RRGGBB" where "RR" is the red, "GG" the green and "BB" the blue component in two hex digits each.

Specified by:

getDisplayString in interface FieldValue

Returns:

An HTML format color string for the label color (an empty string if it has no value).

getDisplayString

public java.lang.String getDisplayString(java.util.Locale locale)

Return a string representation for the color of this label. The string is formatted according to the HTML specification using "#RRGGBB" where "RR" is the red, "GG" the green and "BB" the blue component in two hex digits each.

Specified by:

getDisplayString in interface FieldValue

Parameters:

locale - This parameter is not used.

Returns:

An HTML format color string for the label color (an empty string if it has no value).

setFromDisplayString

public void setFromDisplayString(java.lang.String value)
                          throws InvalidArgumentException

Set the label field value from a string representation of the color. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog. The string is formatted according to the HTML specification using "#RRGGBB" where "RR" is the red, "GG" the green and "BB" the blue component in two hex digits each.

Specified by:

setFromDisplayString in interface FieldValue

Parameters:

value - The display string to set the value from.

Throws:

InvalidArgumentException - if the given string is not correct.

setFromDisplayString

public void setFromDisplayString(java.util.Locale locale,
                        java.lang.String value)
                          throws InvalidArgumentException

Set the label field value from a string representation of the color. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog. The string is formatted according to the HTML specification using "#RRGGBB" where "RR" is the red, "GG" the green and "BB" the blue component in two hex digits each.

Specified by:

setFromDisplayString in interface FieldValue

Parameters:

locale - This parameter is not used.

value - The display string to set the value from.

Throws:

InvalidArgumentException - if the given string is not correct.

getColor

public int getColor()

Get the color value for this label field value. The color is a 4-byte integer value with the following format: 0x00RRGGBB where "RR" is the red, "GG" the green and "BB" the blue component in two hex digits each.

Returns:

The color value of this label field value.

setColor

public void setColor(int color)

Set the label field value from a color value. The color is a 4-byte integer value with the following format: 0x00RRGGBB where "RR" is the red, "GG" the green and "BB" the blue component in two hex digits each. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog. The color value needs to match one of the possible values for this field in the catalog.

Parameters:

color - The new color value of this label field value.

getID

public int getID()

Because a "Label" field is a value interpretation of a string list field this method allows you to get down to the ID of the string list value. The ID does not correspond to the color value but identifies an entry in the string list.

Returns:

The underlying string list ID value for this field value.

setID

public void setID(int enumID)

Because a "Label" field is a value interpretation of a string list field this method allows you to set the field value using the ID of the underlying string list value. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog. The ID does not correspond to the color value but identifies an entry in the string list.

Parameters:

enumID - The underlying string list ID value for this field value.

toString

public java.lang.String toString()

Same as getDisplayString().

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this field value (an empty string if it has no value).