com.ibm.ecm.configuration

Class InterfaceTextConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.InterfaceTextConfig

All Implemented Interfaces:

java.io.Serializable

public class InterfaceTextConfig
extends ConfigurationObject
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LABEL_DATA
static java.lang.String	LOCALE_DATA

Fields inherited from class com.ibm.ecm.configuration.ConfigurationObject

ARRAY_DELIMITER, cloned, configuration, DEFAULT_PROPERTY_VALUE_MAP, ERROR_MISSING_KEY, fromTenant, KEY_DELIMITER, LIST_ESC_CHAR, LIST_SEPARATOR, MODIFIER, PLACEHOLDER_SECRET, properties, returnCopyFromCache

Constructor Summary

Constructors

Constructor and Description
InterfaceTextConfig(org.apache.commons.configuration.Configuration configuration, java.lang.String idPrefix, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassicLabelKey()
protected java.lang.Class	getDataType(java.lang.String key) Returns the datatype of a configuration property.
java.lang.String	getDesktopId()
java.lang.String	getDisplayedIn()
InterfaceTextLabelConfig	getLabelData()
java.lang.String	getLabelKey()
InterfaceTextLocaleConfig	getLocaleData()
java.lang.String	getObjectType() Abstract method to return object type.
java.lang.String	getRepositoryId()
java.lang.String	getRepositoryType()
java.lang.String	getTooltipKey()
java.lang.String	getType()
boolean	isTypeAction()
void	setClassicLabelKey(java.lang.String classicLabelKey)
void	setDesktopId(java.lang.String id)
void	setDisplayedIn(java.lang.String displayedIn)
void	setLabelKey(java.lang.String labelKey)
void	setRepositoryId(java.lang.String id)
void	setRepositoryType(java.lang.String type)
void	setTooltipKey(java.lang.String tooltipKey)
void	setType(java.lang.String type)
void	setUserData(java.lang.String[] userData)
protected boolean	skipThisPropertyWhenSaving(java.lang.String key) propertiesToString has been removed and replaced by this method.

Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject

addIdNameToJSONModel, addValueToList, arrayToString, arrayToString, clone, covertEmptyStringtoNull, createJSONModelField, createJSONModelToggleField, createJSONModelValidationField, delete, dump, fromJSONModel, getBooleanPropertyValue, getConfigurationObject, getDataTypeValue, getDoublePropertyValue, getIdPrefix, getIntPropertyValue, getKey, getList, getLongPropertyValue, getMap, getName, getObjectId, getObjectIdAlias, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, hasProperties, isEmpty, isNew, load, performSyncedUpdate, propertiesToString, removeValuesFromList, removeValuesFromList, resetNonTenantSettings, returnCopyFromCache, save, setDefaultValue, setProperties, setProperty, setValues, setValues, setValues, setValues, stringToArray, stringToList, toJSON, toJSON, toJSONModel, toString, validate, validateObjectId, writeConfigurationToFile

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE_DATA

public static final java.lang.String LOCALE_DATA

See Also:

Constant Field Values

LABEL_DATA

public static final java.lang.String LABEL_DATA

See Also:

Constant Field Values

Constructor Detail

InterfaceTextConfig

public InterfaceTextConfig(org.apache.commons.configuration.Configuration configuration,
                           java.lang.String idPrefix,
                           java.lang.String id)

Method Detail

getObjectType

public java.lang.String getObjectType()

Description copied from class: ConfigurationObject

Abstract method to return object type.

Specified by:

getObjectType in class ConfigurationObject

Returns:

a string object type back, for example "desktop", "repository"...

getDataType

protected java.lang.Class getDataType(java.lang.String key)

Description copied from class: ConfigurationObject

Returns the datatype of a configuration property. This is implemented in subclasses and is used to properly serialize the properties. The default implementation returns null which indicates that compatible behavior should be used, which inspects the property value itself and guesses at the type of the property.

Overrides:

getDataType in class ConfigurationObject

Parameters:

key - ths name of the property

Returns:

a Class instance describing the datatype of the property.

getLocaleData

public InterfaceTextLocaleConfig getLocaleData()

getLabelData

public InterfaceTextLabelConfig getLabelData()

skipThisPropertyWhenSaving

protected boolean skipThisPropertyWhenSaving(java.lang.String key)

propertiesToString has been removed and replaced by this method. We don't need to two methods to do saving just in case other developers are not aware of it and made changes to the main but not the derived class one.

Overrides:

skipThisPropertyWhenSaving in class ConfigurationObject

Parameters:

key - - A string value of property name.

Returns:

a boolean value, true to skip this property in saving and false is otherwise.

getLabelKey

public java.lang.String getLabelKey()

setLabelKey

public void setLabelKey(java.lang.String labelKey)

getTooltipKey

public java.lang.String getTooltipKey()

setTooltipKey

public void setTooltipKey(java.lang.String tooltipKey)

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

isTypeAction

public boolean isTypeAction()

getRepositoryType

public java.lang.String getRepositoryType()

setRepositoryType

public void setRepositoryType(java.lang.String type)

getRepositoryId

public java.lang.String getRepositoryId()

setRepositoryId

public void setRepositoryId(java.lang.String id)

getDesktopId

public java.lang.String getDesktopId()

setDesktopId

public void setDesktopId(java.lang.String id)

getDisplayedIn

public java.lang.String getDisplayedIn()

setDisplayedIn

public void setDisplayedIn(java.lang.String displayedIn)

getClassicLabelKey

public java.lang.String getClassicLabelKey()

setClassicLabelKey

public void setClassicLabelKey(java.lang.String classicLabelKey)

setUserData

public void setUserData(java.lang.String[] userData)