public class

Property

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

Class Overview

Title: Property.

Description: This class represents the properties which can be used to store html formatting

Copyright: Copyright (c) 2003

Company: MicroStrategy, Inc.

Summary

Constants
String ATT_APPLIES_TO
String ATT_ATTR_NAME
String ATT_ENCODE_VALUE
String ATT_HTML_PROP_NAME
String ATT_MAPPED_PROP_NAME
String ATT_STYLE_NAME
String ATT_TARGET
String ATT_TYPE
String NODE_PROPERTY constant for the Property node name
String PROP_APPLIES_TO_ALL
String PROP_APPLIES_TO_NONE
String PROP_TYPE_ALIGN
String PROP_TYPE_BACK_STYLE
String PROP_TYPE_BORDER_STYLE
String PROP_TYPE_COLOR
String PROP_TYPE_DECORATION
String PROP_TYPE_DEFAULT
String PROP_TYPE_HEIGHT_MODE
String PROP_TYPE_LINE_HEIGHT
String PROP_TYPE_PADDING
String PROP_TYPE_POSITION
String PROP_TYPE_SIZE
String PROP_TYPE_WEIGHT
String PROP_TYPE_WIDTH_MODE
String PROP_TYPE_ZOOM
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
Property()
Class constructor
Property(String xml)
Class constructor.
Property(Node root)
Class constructor.
Property(Document doc)
Class constructor.
Public Methods
String getAppliesTo()
Get the objects to which this porperty applies to
String getAttrName()
Get the html attribute for this Property
boolean getEncodeValue()
Get if the value is encoded
String getHTMLPropertyName()
Get the html name of the Property
String getMappedPropertyName()
Get the mapped Property name
String getPropertyType()
Get the tye of the property
HashList getPropertyValues()
This method is deprecated. For performance reasons is better to use getValueList()
String getStylePropertyName()
Get the style name of the Property
String getTarget()
Get the target for this Property
AbstractConfigurationElement.FilteredList getValueList()
Get the list of property values
void setAppliesTo(String value)
Set the objects to which this porperty applies to
void setAttrName(String value)
Set the html attribute for this Property
void setEncodeValue(boolean value)
Set true if the value is encoded
void setHTMLPropertyName(String value)
Set the html name of the Property
void setMappedPropertyName(String value)
Set the mapped name of the Property
void setPropertyType(String value)
Set the type of the Property
void setStylePropertyName(String value)
Set the style name of the Property
void setTarget(String value)
Set the target for this Property
Protected Methods
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.
void initDefaultAttributes()
This method can be overridden to set default values for attributes.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationElementList
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_APPLIES_TO

Constant Value: "appliesTo"

public static final String ATT_ATTR_NAME

Constant Value: "attrName"

public static final String ATT_ENCODE_VALUE

Constant Value: "encodeValue"

public static final String ATT_HTML_PROP_NAME

Constant Value: "htmlPropName"

public static final String ATT_MAPPED_PROP_NAME

Constant Value: "mappedPropName"

public static final String ATT_STYLE_NAME

Constant Value: "styleName"

public static final String ATT_TARGET

Constant Value: "target"

public static final String ATT_TYPE

Constant Value: "type"

public static final String NODE_PROPERTY

constant for the Property node name

Constant Value: "property"

public static final String PROP_APPLIES_TO_ALL

Constant Value: "all"

public static final String PROP_APPLIES_TO_NONE

Constant Value: "none"

public static final String PROP_TYPE_ALIGN

Constant Value: "align"

public static final String PROP_TYPE_BACK_STYLE

Constant Value: "backStyle"

public static final String PROP_TYPE_BORDER_STYLE

Constant Value: "borderStyle"

public static final String PROP_TYPE_COLOR

Constant Value: "color"

public static final String PROP_TYPE_DECORATION

Constant Value: "decoration"

public static final String PROP_TYPE_DEFAULT

Constant Value: "default"

public static final String PROP_TYPE_HEIGHT_MODE

Constant Value: "heightMode"

public static final String PROP_TYPE_LINE_HEIGHT

Constant Value: "lineHeight"

public static final String PROP_TYPE_PADDING

Constant Value: "padding"

public static final String PROP_TYPE_POSITION

Constant Value: "position"

public static final String PROP_TYPE_SIZE

Constant Value: "size"

public static final String PROP_TYPE_WEIGHT

Constant Value: "weight"

public static final String PROP_TYPE_WIDTH_MODE

Constant Value: "widthMode"

public static final String PROP_TYPE_ZOOM

Constant Value: "zoom"

Public Constructors

public Property ()

Class constructor

public Property (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.

public Property (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.

public Property (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

Public Methods

public String getAppliesTo ()

Get the objects to which this porperty applies to

Returns
  • The objects to which this porperty applies to

public String getAttrName ()

Get the html attribute for this Property

Returns
  • The HTML attribute name of the property.

public boolean getEncodeValue ()

Get if the value is encoded

Returns
  • true if the value is encoded.

public String getHTMLPropertyName ()

Get the html name of the Property

Returns
  • The HTML name of the property.

public String getMappedPropertyName ()

Get the mapped Property name

Returns
  • The mapped name of the property.

public String getPropertyType ()

Get the tye of the property

Returns
  • The type of the property.

public HashList getPropertyValues ()

This method is deprecated.
For performance reasons is better to use getValueList()

Get the list of property values

Returns
  • arguments list of property values

public String getStylePropertyName ()

Get the style name of the Property

Returns
  • The style name of the property.

public String getTarget ()

Get the target for this Property

Returns
  • The HTML attribute name of the property.

public AbstractConfigurationElement.FilteredList getValueList ()

Get the list of property values

Returns
  • arguments list of property values

public void setAppliesTo (String value)

Set the objects to which this porperty applies to

Parameters
value The objects to which this porperty applies to

public void setAttrName (String value)

Set the html attribute for this Property

Parameters
value The html attribute name of the property.

public void setEncodeValue (boolean value)

Set true if the value is encoded

Parameters
value Set to true if the value is encoded.

public void setHTMLPropertyName (String value)

Set the html name of the Property

Parameters
value The html name of the property.

public void setMappedPropertyName (String value)

Set the mapped name of the Property

Parameters
value The mapped name of the property.

public void setPropertyType (String value)

Set the type of the Property

Parameters
value The type of the property.

public void setStylePropertyName (String value)

Set the style name of the Property

Parameters
value The style name of the property.

public void setTarget (String value)

Set the target for this Property

Parameters
value The html attribute name of the property.

Protected Methods

protected 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.

protected void initDefaultAttributes ()

This method can be overridden to set default values for attributes. Simply extend this method and call setAttribute(String, Object)