public class

WebGuiComponent

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

Class Overview

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.

Summary

Constants
String ATT_BASE_BEAN
String ATT_CLASS
String ATT_FEATURE
String ATT_IS_CONTAINER
String ATT_NAME
String ATT_STATUS
String ATT_STYLE_NAME
String ATT_STYLE_TYPE
String ATT_SUBTYPE
String ATT_TYPE
String NODE_WEB_COMPONENT
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
WebGuiComponent()
Class constructor.
WebGuiComponent(String name)
Class constructor.
WebGuiComponent(Node root)
Class constructor.
Public Methods
void addEvent(ShortcutEvent evt)
void clearEvents()
String getBaseBean()
Get the baseBean property value of the WebGuiComponent instance
String getClassName()
Get the ClassName property value of the WebGuiComponent instance
AbstractConfigurationElement.FilteredList getEventList()
Returns the list of events associated with this WebGuiComponent
HashList getEvents()
This method is deprecated. Use getEventList()
String getFeature()
Get the feature property value of the WebGuiComponent instance
String getIsContainer()
Get the isContainer property value of the WebGuiComponent instance
String getName()
Get the name of the WebGuiComponent instance
WebBeanPropertyList getPropertyList()
Get the collection of bean properties for the component element.
int getStatus()
String getStyleName()
Get the styleName property value of the WebGuiComponent instance
String getStyleType()
Get the styleType property value of the WebGuiComponent instance
String getSubtype()
Get the Subtype property value of the WebGuiComponent instance
String getType()
Get the Type property value of the WebGuiComponent instance
void setBaseBean(String value)
Set the sysBean property value of the WebGuiComponent instance
void setClassName(String value)
Set the ClassName property value of the WebGuiComponent instance
void setFeature(String value)
Set the feature property value of the WebGuiComponent instance
void setIsContainer(String value)
Set the isContainer property value of the WebGuiComponent instance
void setName(String name)
Set the name of the WebGuiComponent instance
void setStatus(int value)
void setStyleName(String value)
Set the styleName property value of the WebGuiComponent instance
void setStyleType(String value)
Set the styleType property value of the WebGuiComponent instance
void setSubtype(String value)
Set the Subtype property value of the WebGuiComponent instance
void setType(String value)
Set the Type property value of the WebGuiComponent instance
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.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_BASE_BEAN

Constant Value: "base-bean"

public static final String ATT_CLASS

Constant Value: "class"

public static final String ATT_FEATURE

Constant Value: "feature-id"

public static final String ATT_IS_CONTAINER

Constant Value: "is-container"

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_STATUS

Constant Value: "status"

public static final String ATT_STYLE_NAME

Constant Value: "style-name"

public static final String ATT_STYLE_TYPE

Constant Value: "style-type"

public static final String ATT_SUBTYPE

Constant Value: "subtype"

public static final String ATT_TYPE

Constant Value: "type"

public static final String NODE_WEB_COMPONENT

Constant Value: "web-component"

Public Constructors

public WebGuiComponent ()

Class constructor. Initializes a new -empty- instance of the WebGuiComponent class.

public WebGuiComponent (String name)

Class constructor. Initializes a new instance of the WebGuiComponent with the values passed as parameters

Parameters
name String name of the bean.

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

Public Methods

public void addEvent (ShortcutEvent evt)

public void clearEvents ()

public String getBaseBean ()

Get the baseBean property value of the WebGuiComponent instance

Returns
  • the int value of the baseBean property

public String getClassName ()

Get the ClassName property value of the WebGuiComponent instance

Returns
  • the int value of the ClassName property

public AbstractConfigurationElement.FilteredList getEventList ()

Returns the list of events associated with this WebGuiComponent

public HashList getEvents ()

This method is deprecated.
Use getEventList()

Get the list of events

Returns
  • events list associated with this shortcut

public String getFeature ()

Get the feature property value of the WebGuiComponent instance

Returns
  • the String value of the feature property

public String getIsContainer ()

Get the isContainer property value of the WebGuiComponent instance

Returns
  • the String value of the isContainer property

public String getName ()

Get the name of the WebGuiComponent instance

Returns
  • the String value of the name property

public WebBeanPropertyList getPropertyList ()

Get the collection of bean properties for the component element.

Returns
  • the WebBeanPropertyList associated with this element.

public int getStatus ()

public String getStyleName ()

Get the styleName property value of the WebGuiComponent instance

Returns
  • the int value of the styleName property

public String getStyleType ()

Get the styleType property value of the WebGuiComponent instance

Returns
  • the int value of the styleType property

public String getSubtype ()

Get the Subtype property value of the WebGuiComponent instance

Returns
  • the int value of the Subtype property

public String getType ()

Get the Type property value of the WebGuiComponent instance

Returns
  • the int value of the Type property

public void setBaseBean (String value)

Set the sysBean property value of the WebGuiComponent instance

Parameters
value the int value of the sysBean property

public void setClassName (String value)

Set the ClassName property value of the WebGuiComponent instance

Parameters
value the int value of the ClassName property

public void setFeature (String value)

Set the feature property value of the WebGuiComponent instance

Parameters
value the String value of the feature property

public void setIsContainer (String value)

Set the isContainer property value of the WebGuiComponent instance

Parameters
value the String value of the isContainer property

public void setName (String name)

Set the name of the WebGuiComponent instance

Parameters
name the String value of the name property - unique identifier of the WebBeanInfo instance.

public void setStatus (int value)

public void setStyleName (String value)

Set the styleName property value of the WebGuiComponent instance

Parameters
value the int value of the styleName property

public void setStyleType (String value)

Set the styleType property value of the WebGuiComponent instance

Parameters
value the int value of the styleType property

public void setSubtype (String value)

Set the Subtype property value of the WebGuiComponent instance

Parameters
value the int value of the Subtype property

public void setType (String value)

Set the Type property value of the WebGuiComponent instance

Parameters
value the int value of the Type 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)