Class AbstractGuiElement

    • Field Detail

      • _name

        protected java.lang.String _name
        name of the gui element
      • _appContext

        protected AppContext _appContext
        the AppContext object associated with this gui element
    • Constructor Detail

      • AbstractGuiElement

        public AbstractGuiElement()
    • Method Detail

      • renderElement

        public boolean renderElement​(MarkupOutput mo)
        Render the current GUI Element with the information provided
        Specified by:
        renderElement in interface GuiElement
        Parameters:
        mo - MarkupOutput instance where the HTML information to display to the user is to be saved.
        Returns:
        boolean value indicating if the render operation was successful or not
      • getDescriptor

        public java.lang.String getDescriptor​(int key)
        get descriptor by a key
        Specified by:
        getDescriptor in interface GuiElement
        Parameters:
        key - the key for the descriptor
        Returns:
        the descriptor
      • getDescriptor

        public java.lang.String getDescriptor​(int key,
                                              java.lang.String defaultValue)
      • getDescriptor

        public java.lang.String getDescriptor​(java.lang.String key)
        get descriptor by a key
        Specified by:
        getDescriptor in interface GuiElement
        Parameters:
        key - the key for the descriptor
        Returns:
        the descriptor
      • setName

        public void setName​(java.lang.String value)
        set the name of the gui element
        Specified by:
        setName in interface GuiElement
        Parameters:
        value - the name
      • getName

        public java.lang.String getName()
        get the name of the gui element
        Specified by:
        getName in interface GuiElement
        Returns:
        the name
      • isIFrameEnabled

        public boolean isIFrameEnabled()
        return whether the gui element is iframe enabled
        Returns:
        whether the gui element is iframe enabled
      • setUseIFrame

        public void setUseIFrame​(boolean value)
        Sets whether a ReportFrameElement should use IFrames in its output
        Specified by:
        setUseIFrame in interface GuiElement
        Parameters:
        value - true if IFrrames are enabled
      • getUseIFrame

        public boolean getUseIFrame()
        Indicates whether the instance uses IFrames in its output
        Specified by:
        getUseIFrame in interface GuiElement
        Returns:
        true if it uses IFrames
      • setExtraUrl

        public void setExtraUrl​(java.lang.String newValue)
        set extra url information for this gui element
        Specified by:
        setExtraUrl in interface GuiElement
        Parameters:
        newValue - the extra url info
      • getExtraUrl

        public java.lang.String getExtraUrl()
        get extra url information for this gui element
        Specified by:
        getExtraUrl in interface GuiElement
        Returns:
        the extra url
      • setExtraInput

        public void setExtraInput​(java.lang.String newValue)
        set extra url information for this gui element
        Specified by:
        setExtraInput in interface GuiElement
        Parameters:
        newValue - the extra input
      • getExtraInput

        public java.lang.String getExtraInput()
        get extra input information for this gui element
        Specified by:
        getExtraInput in interface GuiElement
        Returns:
        the extra input
      • isDhtml

        public boolean isDhtml()
        Returns true if the output mode has been set to dhtml
        Returns:
        boolean value of True if the output of this element is DHTML; returns False otherwise.
        Since:
        MicroStrategy Web 8.0.0
      • newURIBuilder

        protected ParameterBuilder newURIBuilder()
        Convenience method to retrieve a new URI Builder object from the stored AppContext.
        Returns:
        A new instance of a ParameterBuilder object that constructs URIs.
        Since:
        MicroStrategy Web 8.0.0
      • newHiddenInputBuilder

        protected ParameterBuilder newHiddenInputBuilder()
        Convenience method to retrieve a new Hidden Input Builder object from the stored AppContext.
        Returns:
        A new instance of a ParameterBuilder object that constructs hidden inputs.
        Since:
        MicroStrategy Web 8.0.0
      • newNamespaceEncoder

        protected NamespaceEncoder newNamespaceEncoder()
        Convenience method to retrieve a new Namespace Encoder object from the stored AppContext.
        Returns:
        A new instance of a NamespaceEncoder object that encode names.
        Since:
        MicroStrategy Web 8.0.0
      • getTagsFactory

        protected TagsFactory getTagsFactory()
        Returns:
        TagsFactory initialized instance
        Since:
        MicroStrategy Web 8.0.0