java.lang.Object
- com.microstrategy.utils.config.AbstractConfigurationElement
- - com.microstrategy.utils.config.AbstractConfigurationElementList
  - - com.microstrategy.web.app.Property

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable
```
public class Property
extends AbstractConfigurationElementList
```
Title: Property.
Description: This class represents the properties which can be used to store html formatting

Copyright: Copyright (c) 2003

Company: MicroStrategy, Inc.

Since:

MicroStrategy Web 8.0.0

Nested Class Summary
- Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
  AbstractConfigurationElement.FilteredList

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ATT_APPLIES_TO`
`static java.lang.String`	`ATT_ATTR_NAME`
`static java.lang.String`	`ATT_ENCODE_VALUE`
`static java.lang.String`	`ATT_HTML_PROP_NAME`
`static java.lang.String`	`ATT_MAPPED_PROP_NAME`
`static java.lang.String`	`ATT_STYLE_NAME`
`static java.lang.String`	`ATT_TARGET`
`static java.lang.String`	`ATT_TYPE`
`static java.lang.String`	`NODE_PROPERTY`	constant for the Property node name
`static java.lang.String`	`PROP_APPLIES_TO_ALL`
`static java.lang.String`	`PROP_APPLIES_TO_NONE`
`static java.lang.String`	`PROP_TYPE_ALIGN`
`static java.lang.String`	`PROP_TYPE_BACK_STYLE`
`static java.lang.String`	`PROP_TYPE_BORDER_STYLE`
`static java.lang.String`	`PROP_TYPE_COLOR`
`static java.lang.String`	`PROP_TYPE_DECORATION`
`static java.lang.String`	`PROP_TYPE_DEFAULT`
`static java.lang.String`	`PROP_TYPE_HEIGHT_MODE`
`static java.lang.String`	`PROP_TYPE_LINE_HEIGHT`
`static java.lang.String`	`PROP_TYPE_PADDING`
`static java.lang.String`	`PROP_TYPE_POSITION`
`static java.lang.String`	`PROP_TYPE_SIZE`
`static java.lang.String`	`PROP_TYPE_WEIGHT`
`static java.lang.String`	`PROP_TYPE_WIDTH_MODE`
`static java.lang.String`	`PROP_TYPE_ZOOM`

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList
ATT_VERSION

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors
Constructor	Description
`Property()`	Class constructor
`Property(java.lang.String xml)`	Class constructor.
`Property(org.w3c.dom.Document doc)`	Class constructor.
`Property(org.w3c.dom.Node root)`	Class constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAppliesTo()`	Get the objects to which this porperty applies to
`java.lang.String`	`getAttrName()`	Get the html attribute for this Property
`boolean`	`getEncodeValue()`	Get if the value is encoded
`java.lang.String`	`getHTMLPropertyName()`	Get the html name of the Property
`protected java.lang.String`	`getKeyAttribute()`	This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the `getKey` and `setKey` methods.
`java.lang.String`	`getMappedPropertyName()`	Get the mapped Property name
`java.lang.String`	`getPropertyType()`	Get the tye of the property
`HashList`	`getPropertyValues()`	Deprecated. For performance reasons is better to use `getValueList()`
`java.lang.String`	`getStylePropertyName()`	Get the style name of the Property
`java.lang.String`	`getTarget()`	Get the target for this Property
`AbstractConfigurationElement.FilteredList`	`getValueList()`	Get the list of property values
`protected void`	`initDefaultAttributes()`	This method can be overridden to set default values for attributes.
`void`	`setAppliesTo(java.lang.String value)`	Set the objects to which this porperty applies to
`void`	`setAttrName(java.lang.String value)`	Set the html attribute for this Property
`void`	`setEncodeValue(boolean value)`	Set true if the value is encoded
`void`	`setHTMLPropertyName(java.lang.String value)`	Set the html name of the Property
`void`	`setMappedPropertyName(java.lang.String value)`	Set the mapped name of the Property
`void`	`setPropertyType(java.lang.String value)`	Set the type of the Property
`void`	`setStylePropertyName(java.lang.String value)`	Set the style name of the Property
`void`	`setTarget(java.lang.String value)`	Set the target for this Property

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList
clear, clone, get, get, getFilteredList, getKey, getList, getValues, getVersion, init, isEmpty, put, put, registerElementInList, remove, setVersion, size, sort

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement
getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

- Field Detail
  - ATT_TARGET
```
public static final java.lang.String ATT_TARGET
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_ATTR_NAME
```
public static final java.lang.String ATT_ATTR_NAME
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_APPLIES_TO
```
public static final java.lang.String ATT_APPLIES_TO
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_TYPE
```
public static final java.lang.String ATT_TYPE
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_ENCODE_VALUE
```
public static final java.lang.String ATT_ENCODE_VALUE
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_MAPPED_PROP_NAME
```
public static final java.lang.String ATT_MAPPED_PROP_NAME
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_STYLE_NAME
```
public static final java.lang.String ATT_STYLE_NAME
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_HTML_PROP_NAME
```
public static final java.lang.String ATT_HTML_PROP_NAME
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - PROP_TYPE_DEFAULT
```
public static final java.lang.String PROP_TYPE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_COLOR
```
public static final java.lang.String PROP_TYPE_COLOR
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_WEIGHT
```
public static final java.lang.String PROP_TYPE_WEIGHT
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_POSITION
```
public static final java.lang.String PROP_TYPE_POSITION
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_SIZE
```
public static final java.lang.String PROP_TYPE_SIZE
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_HEIGHT_MODE
```
public static final java.lang.String PROP_TYPE_HEIGHT_MODE
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_WIDTH_MODE
```
public static final java.lang.String PROP_TYPE_WIDTH_MODE
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_BACK_STYLE
```
public static final java.lang.String PROP_TYPE_BACK_STYLE
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_LINE_HEIGHT
```
public static final java.lang.String PROP_TYPE_LINE_HEIGHT
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_PADDING
```
public static final java.lang.String PROP_TYPE_PADDING
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_DECORATION
```
public static final java.lang.String PROP_TYPE_DECORATION
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_BORDER_STYLE
```
public static final java.lang.String PROP_TYPE_BORDER_STYLE
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_ZOOM
```
public static final java.lang.String PROP_TYPE_ZOOM
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE_ALIGN
```
public static final java.lang.String PROP_TYPE_ALIGN
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - PROP_APPLIES_TO_ALL
```
public static final java.lang.String PROP_APPLIES_TO_ALL
```
    See Also:
    
    Constant Field Values
  - PROP_APPLIES_TO_NONE
```
public static final java.lang.String PROP_APPLIES_TO_NONE
```
    See Also:
    
    Constant Field Values
  - NODE_PROPERTY
```
public static final java.lang.String NODE_PROPERTY
```
    constant for the Property node name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Property
```
public Property()
```
    Class constructor
  - Property
```
public Property(java.lang.String xml)
```
    Class constructor. Creates a new instance of the Property, initializing it with the information provided on an xml string.
    
    Parameters:
    
    xml - Xml String to use for initializing the object.
  - Property
```
public Property(org.w3c.dom.Node root)
```
    Class constructor. Creates a new instance of the Property, initializing it with the information provided on an xml Node.
    
    Parameters:
    
    root - Node instance representing the different pages information.
  - Property
```
public Property(org.w3c.dom.Document doc)
```
    Class constructor. Creates a new instance of the Property, initializing it with the information provided on an xml Document.
    
    Parameters:
    
    doc - DOM Document with information to initialize this class
- Method Detail
  - getKeyAttribute
```
protected java.lang.String getKeyAttribute()
```
    Description copied from class: AbstractConfigurationElement
    
    This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
    
    Overrides:
    
    getKeyAttribute in class AbstractConfigurationElementList
    
    Since:
    
    MicroStrategy Web 9.0.0
  - initDefaultAttributes
```
protected void initDefaultAttributes()
```
    Description copied from class: AbstractConfigurationElement
    
    This method can be overridden to set default values for attributes. Simply extend this method and call AbstractConfigurationElement.setAttribute(java.lang.String, java.lang.Object)
    
    Overrides:
    
    initDefaultAttributes in class AbstractConfigurationElement
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getValueList
```
public AbstractConfigurationElement.FilteredList getValueList()
```
    Get the list of property values
    
    Returns:
    
    arguments list of property values
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getPropertyValues
```
@Deprecated
public HashList getPropertyValues()
```
    Deprecated.
    For performance reasons is better to use getValueList()
    
    Get the list of property values
    
    Returns:
    
    arguments list of property values
  - getHTMLPropertyName
```
public java.lang.String getHTMLPropertyName()
```
    Get the html name of the Property
    
    Returns:
    
    The HTML name of the property.
  - setHTMLPropertyName
```
public void setHTMLPropertyName(java.lang.String value)
```
    Set the html name of the Property
    
    Parameters:
    
    value - The html name of the property.
  - getStylePropertyName
```
public java.lang.String getStylePropertyName()
```
    Get the style name of the Property
    
    Returns:
    
    The style name of the property.
  - setStylePropertyName
```
public void setStylePropertyName(java.lang.String value)
```
    Set the style name of the Property
    
    Parameters:
    
    value - The style name of the property.
  - getAttrName
```
public java.lang.String getAttrName()
```
    Get the html attribute for this Property
    
    Returns:
    
    The HTML attribute name of the property.
  - setAttrName
```
public void setAttrName(java.lang.String value)
```
    Set the html attribute for this Property
    
    Parameters:
    
    value - The html attribute name of the property.
  - getTarget
```
public java.lang.String getTarget()
```
    Get the target for this Property
    
    Returns:
    
    The HTML attribute name of the property.
  - setTarget
```
public void setTarget(java.lang.String value)
```
    Set the target for this Property
    
    Parameters:
    
    value - The html attribute name of the property.
  - getMappedPropertyName
```
public java.lang.String getMappedPropertyName()
```
    Get the mapped Property name
    
    Returns:
    
    The mapped name of the property.
  - setMappedPropertyName
```
public void setMappedPropertyName(java.lang.String value)
```
    Set the mapped name of the Property
    
    Parameters:
    
    value - The mapped name of the property.
  - getEncodeValue
```
public boolean getEncodeValue()
```
    Get if the value is encoded
    
    Returns:
    
    true if the value is encoded.
  - setEncodeValue
```
public void setEncodeValue(boolean value)
```
    Set true if the value is encoded
    
    Parameters:
    
    value - Set to true if the value is encoded.
  - getPropertyType
```
public java.lang.String getPropertyType()
```
    Get the tye of the property
    
    Returns:
    
    The type of the property.
  - setPropertyType
```
public void setPropertyType(java.lang.String value)
```
    Set the type of the Property
    
    Parameters:
    
    value - The type of the property.
  - getAppliesTo
```
public java.lang.String getAppliesTo()
```
    Get the objects to which this porperty applies to
    
    Returns:
    
    The objects to which this porperty applies to
  - setAppliesTo
```
public void setAppliesTo(java.lang.String value)
```
    Set the objects to which this porperty applies to
    
    Parameters:
    
    value - The objects to which this porperty applies to

Class Property

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

Field Summary

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

Constructor Summary

Method Summary

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

Methods inherited from class java.lang.Object

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

Field Detail

ATT_TARGET

ATT_ATTR_NAME

ATT_APPLIES_TO

ATT_TYPE

ATT_ENCODE_VALUE

ATT_MAPPED_PROP_NAME

ATT_STYLE_NAME

ATT_HTML_PROP_NAME

PROP_TYPE_DEFAULT

PROP_TYPE_COLOR

PROP_TYPE_WEIGHT

PROP_TYPE_POSITION

PROP_TYPE_SIZE

PROP_TYPE_HEIGHT_MODE

PROP_TYPE_WIDTH_MODE

PROP_TYPE_BACK_STYLE

PROP_TYPE_LINE_HEIGHT

PROP_TYPE_PADDING

PROP_TYPE_DECORATION

PROP_TYPE_BORDER_STYLE

PROP_TYPE_ZOOM

PROP_TYPE_ALIGN

PROP_APPLIES_TO_ALL

PROP_APPLIES_TO_NONE

NODE_PROPERTY

Constructor Detail

Property

Property

Property

Property

Method Detail

getKeyAttribute

initDefaultAttributes

getValueList

getPropertyValues

getHTMLPropertyName

setHTMLPropertyName

getStylePropertyName

setStylePropertyName

getAttrName

setAttrName

getTarget

setTarget

getMappedPropertyName

setMappedPropertyName

getEncodeValue

setEncodeValue

getPropertyType

setPropertyType

getAppliesTo

setAppliesTo