Package com.microstrategy.web.objects.rw

Interface RWControlDef

    • Method Detail

      • getControl

        RWControl getControl()
        Returns control associated with this unit
        Returns:
        control associated with this unit

      • setControlType

        void setControlType​(int newType)
        Sets control type
        Parameters:
        newType - control type

      • setControlTargteType

        void setControlTargteType​(int newTargteType)
        Sets control target type
        Parameters:
        newType - control target type

      • setStyle

        void setStyle​(int value)
        Sets control style
        Parameters:
        value - control style (see EnumRWControlStyle)

      • getStyle

        int getStyle()
        Gets control style (see EnumRWControlStyle)
        Returns:
        control style

      • setOrientation

        void setOrientation​(int value)
        Sets control orientation
        Parameters:
        value - orientation (see EnumRWOrientation).

      • getOrientation

        int getOrientation()
        Gets control orientation
        Returns:
        control orientation (see EnumRWOrientation)

      • setOrientationBehavior

        void setOrientationBehavior​(int value)
        Sets control orientation behavior
        Parameters:
        value - orientation behavior

      • getOrientationBehavior

        int getOrientationBehavior()
        Gets control orientation behavior
        Returns:
        control orientation behavior

      • setMouseOverAction

        void setMouseOverAction​(int value)
        Sets control mouse over action. (Used for Flash only).
        Parameters:
        value - mouse over action.

      • getMouseOverAction

        int getMouseOverAction()
        Returns control mouse over action. (Used for Flash only).
        Returns:
        control mouse over action

      • isMultiSelect

        boolean isMultiSelect()
        Returns true if control allows multiple selections
        Returns:
        true if control allows multiple selections

      • isMultiSelectWithLittleCorrectionOnRWAttributeSelector

        boolean isMultiSelectWithLittleCorrectionOnRWAttributeSelector()
        THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT. Note: Here logic is focused on multi-select info in selector formatting. Returns true if control allows multiple selections
        Returns:
        true if control allows multiple selections

      • setMultiSelect

        void setMultiSelect​(boolean value)
        Sets multi-select mode
        Parameters:
        value - if true, then control will allow multiple selections.

      • isShowAll

        boolean isShowAll()
        Returns true if control displays the Select All option and supports selecting all elements
        Returns:
        true if control displays the Select All and supports selecting all elements

      • setShowAll

        void setShowAll​(boolean value)
        Sets Show All option
        Parameters:
        value - if true the control will display the Select All option. Using this option users can select all available elements.

      • canMultiSelect

        boolean canMultiSelect()
        Returns true if control can support multiple selections. (Controls like pool downs and radio buttons can support only single selection).
        Returns:
        true if control can support multiple selections

      • canSingleSelect

        boolean canSingleSelect()
        Returns true if control can support single selections. (Controls like check boxes can support only multipple selections).
        Returns:
        boolean

      • getItemWidthMode

        int getItemWidthMode()
        Returns item width mode.
        Returns:
        item width mode (see EnumRWItemWidthMode)

      • setItemWidthMode

        void setItemWidthMode​(int value)
        Sets item width mode.
        Parameters:
        value - item width mod (see EnumRWItemWidthMode)

      • getAllAlias

        java.lang.String getAllAlias()
        Returns alias to be used for Select All option
        Returns:
        alias to be used for Select All option

      • getSduc

        boolean getSduc()
        Returns sduc to be used for UC Current State
        Returns:
        Returns sduc to be used for UC Current State

      • setAllAlias

        void setAllAlias​(java.lang.String value)
        Sets alias to be used for Select All option
        Parameters:
        value - alias

      • getAutoSyncMode

        int getAutoSyncMode()
        Returns AutoSync mode
        Returns:
        AutoSync mode
        Since:
        MicroStrategy Web 8.1.1

      • setAutoSyncMode

        void setAutoSyncMode​(int value)
        Sets AutoSync mode.
        Parameters:
        value -
        Since:
        MicroStrategy Web 8.1.1

      • getInclude

        boolean getInclude()
        Returns control selection include/exclude mode.
        Returns:
        include/exclude mode

      • getControlNodeKey

        java.lang.String getControlNodeKey()
        Returns control node key
        Returns:
        control node key

      • getControlNodeThresholds

        WebThresholds getControlNodeThresholds()
        Returns the Thresholds associated with the node of action selector.
        Returns:
        The WebThresholds object associated with this container.