Interface GuiElement

    • Method Detail

      • renderElement

        MarkupOutput renderElement()
        Render the GUI Element represented by this instance
        Returns:
        a MarkupOutput instance initialized with the HTML code to render for this element
      • renderElement

        boolean renderElement​(MarkupOutput out)
      • getMessages

        Messages getMessages()
        Get the Messages instance used by this element
        Returns:
        the Messages instance assigned to this element
      • setName

        void setName​(java.lang.String editorName)
        Set the name property of this GUI element
        Parameters:
        editorName - String with the name to associate to this element
      • getName

        java.lang.String getName()
        Get the name property of this GUI element
        Returns:
        a String with the name associated to this element
      • setAppContext

        void setAppContext​(AppContext value)
        Set the AppContext instance to be used by this element
        Parameters:
        value - the AppContext instance to assign to this element
      • getAppContext

        AppContext getAppContext()
        Get the AppContext instance used by this element
        Returns:
        the AppContext instance assigned to this element
      • setWebComponent

        void setWebComponent​(WebComponent value)
        Set the WebComponent instance to be used by this element
        Parameters:
        value - the WebComponent instance to assign to this element
      • getDescriptor

        java.lang.String getDescriptor​(int key)
        Get the descriptor associated with the numeric key given
        Parameters:
        key - an int representing the key to search for
        Returns:
        the String descriptor found related with the given key
      • getDescriptor

        java.lang.String getDescriptor​(java.lang.String key)
        Get the descriptor associated with the string key given
        Parameters:
        key - a String representing the key to search for
        Returns:
        the String descriptor found related with the given key
      • setUseIFrame

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

        boolean getUseIFrame()
        Indicates whether a ReportFrameElement uses IFrames in its output
        Returns:
        true if it uses IFrames
      • setExtraUrl

        void setExtraUrl​(java.lang.String newValue)
        set extra url info for the gui element
        Parameters:
        newValue - the extra url info
      • getExtraUrl

        java.lang.String getExtraUrl()
        get extra url info for the gui element
        Returns:
        the extra url info
      • setExtraInput

        void setExtraInput​(java.lang.String newValue)
        set extra input info for the gui element
        Parameters:
        newValue - extra input info
      • getExtraInput

        java.lang.String getExtraInput()
        get extra input info for the gui element
        Returns:
        extra input info