Interface AppComponent

    • Field Detail

      • COMPONENT_POSITION_NOT_INITIALIZED

        static final int COMPONENT_POSITION_NOT_INITIALIZED
        Constant indicating the value for the position of the bean has not been specified
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
    • Method Detail

      • getAppContext

        AppContext getAppContext()
        This method returns the application context object associated with this component. To set this context, use WebComponent.setBeanContext passing in an application context object.
        Returns:
        AppContext
      • getEventManager

        EventManager getEventManager()
        This method returns the application EventManager used to generates events.
        Returns:
        EventManager
      • getDescriptor

        java.lang.String getDescriptor​(int key)
        Retrieve the descriptor when the key is an integer value...
        Parameters:
        key - The key of the string to use
        Returns:
        the corresponding descriptor
      • getDescriptor

        java.lang.String getDescriptor​(java.lang.String key)
        Retrieve the descriptor when the key is a string
        Parameters:
        key - The key of the string to use
        Returns:
        the corresponding descriptor
      • setIsOpen

        void setIsOpen​(boolean value)
        Sets the bean to its enabled mode, meaning the editor will be visible to the user
        Parameters:
        value - boolean value indicating if the instance should be defined as opened (True) or closed (False).
        Since:
        MicroStrategy Web 8.0.0
      • setHasJustOpened

        void setHasJustOpened​(boolean value)
        Sets whether the component has just been opened.
        Parameters:
        value - hasJustOpend or not
        Since:
        MicroStrategy Web 8.1.1
      • isOpen

        boolean isOpen()
        Retrieves the open/close state of the bean
        Returns:
        true if the bean is open and should be visible to end users
        Since:
        MicroStrategy Web 8.0.0
      • setIsModal

        void setIsModal​(boolean value)
        Sets the bean to its modal mode. When true the editor will appear as floating on top of the web page and the user cannot interact with other beans.
        Parameters:
        value - boolean value indicating if the instance will be handled as Modal (True) or not.
        Since:
        MicroStrategy Web 8.0.0
      • isModal

        boolean isModal()
        Retrieves the modal state of the bean
        Returns:
        true if the bean should be treated as modal (i.e., no other beans can interact with the user).
        Since:
        MicroStrategy Web 8.0.0
      • setIsDialog

        void setIsDialog​(boolean value)
        Sets the bean to its dialog mode. When true the editor will appear as floating on top of the web page.
        Parameters:
        value - boolean value indicating if the instance will be handled as a Dialog (True) or not.
        Since:
        MicroStrategy Web 8.0.0
      • isDialog

        boolean isDialog()
        Returns true if this bean should be treated as a dialog
        Returns:
        true if this bean should be treated as a dialog
        Since:
        MicroStrategy Web 8.0.0
      • setTop

        void setTop​(int y)
        Set the top position where the bean should be displayed by the transform if applicable.
        Parameters:
        y - Coordinate indicating the new top position of the bean
        Since:
        MicroStrategy Web 8.0.0
      • setLeft

        void setLeft​(int x)
        Set the left position where the bean should be displayed by the transform if applicable.
        Parameters:
        x - Coordinate indicating the new left position of the bean
        Since:
        MicroStrategy Web 8.0.0
      • getTop

        int getTop()
        Get the top position where the bean should be displayed by the transform if applicable
        Returns:
        an integer value where the coordinate to use is saved
        Since:
        MicroStrategy Web 8.0.0
      • getLeft

        int getLeft()
        Get the left position where the bean should be displayed by the transform if applicable
        Returns:
        an integer value where the coordinate to use is saved
        Since:
        MicroStrategy Web 8.0.0
      • setExtraUrl

        void setExtraUrl​(java.lang.String newValue)
        Set any extra url information to be used when generating link information on the transforms associated with this instance.
        Parameters:
        newValue - String with any extra url information to use
        Since:
        MicroStrategy Web 8.0.0
      • getExtraUrl

        java.lang.String getExtraUrl()
        Get any extra url information to be used when generating link information on the transforms associated with this instance.
        Returns:
        String with any extra url information to use
        Since:
        MicroStrategy Web 8.0.0
      • setExtraInput

        void setExtraInput​(java.lang.String newValue)
        Set any extra input form information to be used when generating form information on the transforms associated with this instance.
        Parameters:
        newValue - String with any extra input form information to use
        Since:
        MicroStrategy Web 8.0.0
      • getExtraInput

        java.lang.String getExtraInput()
        Get any extra input form information to be used when generating form information on the transforms associated with this instance.
        Returns:
        String with any extra input form information to use
        Since:
        MicroStrategy Web 8.0.0
      • setForcedChildrenStateSaving

        void setForcedChildrenStateSaving​(boolean value)
        Forces the bean state to be save despite it's open or closed state.
        Since:
        MicroStrategy Web 8.1.1
      • isForcedChildrenStateSaving

        boolean isForcedChildrenStateSaving()
        Return whether the state will be save despite it's open or closed state.
        Since:
        MicroStrategy Web 8.1.1
      • getResultFilterMode

        int getResultFilterMode()
        Since:
        MicroStrategy Web 8.1.1
      • isModalOpen

        boolean isModalOpen()
        indicates whether there is a Modal AppComponent open in the hierarchy
        Returns:
        boolean. true is a Modal AppComponent is open in the hierarchy
        Since:
        MicroStrategy Web 9.0.1