Package com.microstrategy.web.app.gui

Interface Scroller

  • All Superinterfaces:
    GuiElement
    All Known Implementing Classes:
    ScrollerImpl
    public interface Scroller
extends GuiElement
    Scroller interface that defines minimum contract all Scroller must implement.
    Since:
    MicroStrategy Web 8.1.0

    • Method Detail

      • setType

        void setType​(int type)
        Sets the type of scroller to display.
        Parameters:
        type - int value as HORIZONTAL_SCROLLER to represent a horizontal scroller, or VERTICAL_SCROLLER to represent a vertical scroller

      • getType

        int getType()
        Returns:
        int value with the type of scroller to display. Possible return values:
        HORIZONTAL_SCROLLER to represent a horizontal scroller
        VERTICAL_SCROLLER to represent a vertical scroller.

      • setMaxUnits

        void setMaxUnits​(int maxUnits)
        Sets the max absolute units the scroller represents.
        Parameters:
        maxUnits - int

      • getMaxUnits

        int getMaxUnits()
        Returns the max absolute units the scroller represents.
        Returns:
        int

      • setIncrement

        void setIncrement​(int increment)
        Sets the increment factor to be used for the scroll. If 20 max units were specified for the scroller and the increment factor defined is 5, then the values will range from 0 to 100, every 5 units.
        Parameters:
        increment - int

      • getIncrement

        int getIncrement()
        Gets the increment factor to be used for the scroll. If 20 max units were specified for the scroller and the increment factor defined is 5, then the values will range from 0 to 100, every 5 units.
        Returns:
        int

      • setStartUnit

        void setStartUnit​(int startUnit)
        Sets the start value of the scrollbar within the scroller, in relation to the maxUnits property.
        Parameters:
        startUnit - int

      • getStartUnit

        int getStartUnit()
        Returns the start value of the scrollbar within the scroller, in relation to the maxUnits property.
        Returns:
        int

      • setEndUnit

        void setEndUnit​(int endUnit)
        Sets the end value of the scrollbar within the scroller, in relation to the maxUnits property.
        Parameters:
        endUnit - int

      • getEndUnit

        int getEndUnit()
        Returns the end value of the scrollbar within the scroller, in relation to the maxUnits property.
        Returns:
        int

      • addProperty

        void addProperty​(java.lang.String key,
                 java.lang.String value)
        Adds a new property set to the scroller bone associated to the scroller Gui Element intance.
        Parameters:
        key - String
        value - String

      • getBonePropertiesGenerator

        JsonGenerator getBonePropertiesGenerator()
        returns the bone properties generator.
        Returns:
        JsonGenerator

      • setSize

        void setSize​(int size)
        Sets the size of the scroller in pixels
        Parameters:
        size - int

      • getSize

        int getSize()

      • setMaxWindowSize

        void setMaxWindowSize​(int windowSize)

      • setIsResizable

        void setIsResizable​(boolean isResizable)

      • getDataLabels

        java.util.List getDataLabels()
        Returns a read/write List that can be used to specify the tooltip text for each of the scroller's data points.
        Returns:
        List

      • setDataLabels

        void setDataLabels​(java.util.List dataLabels)

      • getDataValues

        java.util.List getDataValues()
        Returns a read/write List that can be used to specify the data values for each of the scroller's data points. One possible usage of this list could be to generate event arguments corresponding to the selections.
        Returns:
        List

      • setScriptClass

        void setScriptClass​(java.lang.String scriptClass)
        Sets the script class that serves as the bone for the scroller.
        Parameters:
        scriptClass - script class.

      • getScriptClass

        java.lang.String getScriptClass()
        Returns the script class that serves as the bone for the scroller.
        Returns:
        String.

      • getStartBase

        int getStartBase()
        Return the first unit on the scroller when the style is SCROLLER_STYLE_INDEX; If the scroller is 0-based scroller, set this to 0; if the scroller is 1-based scroller, set this to 1. If other cases, just set the first number which would appear at the left/lower end of the scroller. Default will be 1-based index.
        Returns:
        The first unit.

      • setStartBase

        void setStartBase​(int startPoint)
           throws java.lang.IllegalArgumentException
        Set the first unit on teh scroller when the style is SCROLLER_STYLE_INDEX If the scroller is 0-based scroller, set this to 0; if the scroller is 1-based scroller, set this to 1. If other cases, just set the first number which would appear at the left/lower end of the scroller. Default will be 1-based index.
        Parameters:
        startPoint - The new number for the start base of the scroller
        Throws:
        java.lang.IllegalArgumentException - Thrown when the scroller is not in style SCROLLER_STYLE_INDEX.

      • isSupportIncludeState

        boolean isSupportIncludeState()
        Set flag to indicate if this scroller support toggleing its selection area between center and sides. This is to support Metric Condition selector's include/exclude selection mode.
        Returns:

      • setSupportIncludeState

        void setSupportIncludeState​(boolean supportIncludeState)

      • getCmdid

        java.lang.String getCmdid()
        Set client-side property 'cmdid'
        Returns:

      • setCmdid

        void setCmdid​(java.lang.String cmdid)