Package com.microstrategy.web.app
Class WebGuiComponent
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.web.app.WebGuiComponent
-
- All Implemented Interfaces:
ConfigurationElement
,ConfigurationFile
,java.lang.Cloneable
public class WebGuiComponent extends AbstractConfigurationElement
The Shortcut WebGuiComponent represents a bean - style pair. This objects can be use to abstract from the user details about the bean transformation and helps to see the elements on the interface as independent components.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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_BASE_BEAN
static java.lang.String
ATT_CLASS
static java.lang.String
ATT_FEATURE
static java.lang.String
ATT_IS_CONTAINER
static java.lang.String
ATT_NAME
static java.lang.String
ATT_STATUS
static java.lang.String
ATT_STYLE_NAME
static java.lang.String
ATT_STYLE_TYPE
static java.lang.String
ATT_SUBTYPE
static java.lang.String
ATT_TYPE
static java.lang.String
NODE_WEB_COMPONENT
-
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 WebGuiComponent()
Class constructor.WebGuiComponent(java.lang.String name)
Class constructor.WebGuiComponent(org.w3c.dom.Node root)
Class constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addEvent(ShortcutEvent evt)
void
clearEvents()
java.lang.String
getBaseBean()
Get the baseBean property value of the WebGuiComponent instancejava.lang.String
getClassName()
Get the ClassName property value of the WebGuiComponent instanceAbstractConfigurationElement.FilteredList
getEventList()
Returns the list of events associated with this WebGuiComponentHashList
getEvents()
Deprecated.UsegetEventList()
java.lang.String
getFeature()
Get the feature property value of the WebGuiComponent instancejava.lang.String
getIsContainer()
Get the isContainer property value of the WebGuiComponent instanceprotected 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 thegetKey
andsetKey
methods.java.lang.String
getName()
Get the name of the WebGuiComponent instanceWebBeanPropertyList
getPropertyList()
Get the collection of bean properties for the component element.int
getStatus()
java.lang.String
getStyleName()
Get the styleName property value of the WebGuiComponent instancejava.lang.String
getStyleType()
Get the styleType property value of the WebGuiComponent instancejava.lang.String
getSubtype()
Get the Subtype property value of the WebGuiComponent instancejava.lang.String
getType()
Get the Type property value of the WebGuiComponent instanceprotected void
initDefaultAttributes()
This method can be overridden to set default values for attributes.void
setBaseBean(java.lang.String value)
Set the sysBean property value of the WebGuiComponent instancevoid
setClassName(java.lang.String value)
Set the ClassName property value of the WebGuiComponent instancevoid
setFeature(java.lang.String value)
Set the feature property value of the WebGuiComponent instancevoid
setIsContainer(java.lang.String value)
Set the isContainer property value of the WebGuiComponent instancevoid
setName(java.lang.String name)
Set the name of the WebGuiComponent instancevoid
setStatus(int value)
void
setStyleName(java.lang.String value)
Set the styleName property value of the WebGuiComponent instancevoid
setStyleType(java.lang.String value)
Set the styleType property value of the WebGuiComponent instancevoid
setSubtype(java.lang.String value)
Set the Subtype property value of the WebGuiComponent instancevoid
setType(java.lang.String value)
Set the Type property value of the WebGuiComponent instance-
Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, 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
-
-
-
-
Field Detail
-
NODE_WEB_COMPONENT
public static final java.lang.String NODE_WEB_COMPONENT
- See Also:
- Constant Field Values
-
ATT_NAME
public static final java.lang.String ATT_NAME
- See Also:
- Constant Field Values
-
ATT_BASE_BEAN
public static final java.lang.String ATT_BASE_BEAN
- See Also:
- Constant Field Values
-
ATT_STYLE_NAME
public static final java.lang.String ATT_STYLE_NAME
- See Also:
- Constant Field Values
-
ATT_STYLE_TYPE
public static final java.lang.String ATT_STYLE_TYPE
- See Also:
- Constant Field Values
-
ATT_STATUS
public static final java.lang.String ATT_STATUS
- See Also:
- Constant Field Values
-
ATT_IS_CONTAINER
public static final java.lang.String ATT_IS_CONTAINER
- See Also:
- Constant Field Values
-
ATT_FEATURE
public static final java.lang.String ATT_FEATURE
- See Also:
- Constant Field Values
-
ATT_TYPE
public static final java.lang.String ATT_TYPE
- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
ATT_SUBTYPE
public static final java.lang.String ATT_SUBTYPE
- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
ATT_CLASS
public static final java.lang.String ATT_CLASS
- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WebGuiComponent
public WebGuiComponent()
Class constructor. Initializes a new -empty- instance of the WebGuiComponent class.
-
WebGuiComponent
public WebGuiComponent(java.lang.String name)
Class constructor. Initializes a new instance of the WebGuiComponent with the values passed as parameters- Parameters:
name
-String
name of the bean.
-
WebGuiComponent
public WebGuiComponent(org.w3c.dom.Node root)
Class constructor. Initializes a WebGuiComponent instance based on the information included on the XML Node- Parameters:
root
- Node instance representing the web bean information.
-
-
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 thegetKey
andsetKey
methods.- Specified by:
getKeyAttribute
in classAbstractConfigurationElement
- 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 callAbstractConfigurationElement.setAttribute(java.lang.String, java.lang.Object)
- Overrides:
initDefaultAttributes
in classAbstractConfigurationElement
- Since:
- MicroStrategy Web 9.0.0
-
setName
public void setName(java.lang.String name)
Set the name of the WebGuiComponent instance- Parameters:
name
- theString
value of the name property - unique identifier of the WebBeanInfo instance.
-
getName
public java.lang.String getName()
Get the name of the WebGuiComponent instance- Returns:
- the
String
value of the name property
-
setBaseBean
public void setBaseBean(java.lang.String value)
Set the sysBean property value of the WebGuiComponent instance- Parameters:
value
- theint
value of the sysBean property
-
getBaseBean
public java.lang.String getBaseBean()
Get the baseBean property value of the WebGuiComponent instance- Returns:
- the
int
value of the baseBean property
-
setStyleName
public void setStyleName(java.lang.String value)
Set the styleName property value of the WebGuiComponent instance- Parameters:
value
- theint
value of the styleName property
-
getStyleName
public java.lang.String getStyleName()
Get the styleName property value of the WebGuiComponent instance- Returns:
- the
int
value of the styleName property
-
setStyleType
public void setStyleType(java.lang.String value)
Set the styleType property value of the WebGuiComponent instance- Parameters:
value
- theint
value of the styleType property
-
getStyleType
public java.lang.String getStyleType()
Get the styleType property value of the WebGuiComponent instance- Returns:
- the
int
value of the styleType property
-
setType
public void setType(java.lang.String value)
Set the Type property value of the WebGuiComponent instance- Parameters:
value
- theint
value of the Type property- Since:
- MicroStrategy Web 8.0.0
-
getType
public java.lang.String getType()
Get the Type property value of the WebGuiComponent instance- Returns:
- the
int
value of the Type property - Since:
- MicroStrategy Web 8.0.0
-
setSubtype
public void setSubtype(java.lang.String value)
Set the Subtype property value of the WebGuiComponent instance- Parameters:
value
- theint
value of the Subtype property- Since:
- MicroStrategy Web 8.0.0
-
getSubtype
public java.lang.String getSubtype()
Get the Subtype property value of the WebGuiComponent instance- Returns:
- the
int
value of the Subtype property - Since:
- MicroStrategy Web 8.0.0
-
setClassName
public void setClassName(java.lang.String value)
Set the ClassName property value of the WebGuiComponent instance- Parameters:
value
- theint
value of the ClassName property- Since:
- MicroStrategy Web 8.0.0
-
getClassName
public java.lang.String getClassName()
Get the ClassName property value of the WebGuiComponent instance- Returns:
- the
int
value of the ClassName property - Since:
- MicroStrategy Web 8.0.0
-
getStatus
public int getStatus()
-
setStatus
public void setStatus(int value)
-
setIsContainer
public void setIsContainer(java.lang.String value)
Set the isContainer property value of the WebGuiComponent instance- Parameters:
value
- theString
value of the isContainer property
-
getIsContainer
public java.lang.String getIsContainer()
Get the isContainer property value of the WebGuiComponent instance- Returns:
- the
String
value of the isContainer property
-
setFeature
public void setFeature(java.lang.String value)
Set the feature property value of the WebGuiComponent instance- Parameters:
value
- theString
value of the feature property
-
getFeature
public java.lang.String getFeature()
Get the feature property value of the WebGuiComponent instance- Returns:
- the
String
value of the feature property
-
getEvents
public HashList getEvents()
Deprecated.UsegetEventList()
Get the list of events- Returns:
- events list associated with this shortcut
-
getEventList
public AbstractConfigurationElement.FilteredList getEventList()
Returns the list of events associated with this WebGuiComponent- Since:
- MicroStrategy Web 9.0.0
-
addEvent
public void addEvent(ShortcutEvent evt)
- Since:
- MicroStrategy Web 9.0.0
-
clearEvents
public void clearEvents()
- Since:
- MicroStrategy Web 9.0.0
-
getPropertyList
public WebBeanPropertyList getPropertyList()
Get the collection of bean properties for the component element.- Returns:
- the
WebBeanPropertyList
associated with this element. - Since:
- MicroStrategy Web 8.0.0
-
-