Package com.microstrategy.web.app

Class 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

    • 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 the getKey and setKey methods.
        Specified by:
        getKeyAttribute in class AbstractConfigurationElement
        Since:
        MicroStrategy Web 9.0.0

      • setName

        public void setName​(java.lang.String name)
        Set the name of the WebGuiComponent instance
        Parameters:
        name - the String 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 - the int 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 - the int 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 - the int 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 - the int 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 - the int 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 - the int 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 - the String 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 - the String 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

        @Deprecated
public HashList getEvents()
        Deprecated.
        Use getEventList()
        Get the list of events
        Returns:
        events list associated with this shortcut

      • 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