public interface

Scroller

implements GuiElement
com.microstrategy.web.app.gui.Scroller
Known Indirect Subclasses

Class Overview

Scroller interface that defines minimum contract all Scroller must implement.

Summary

Constants
int HORIZONTAL_SCROLLER
int SCROLLER_BACKGROUND
int SCROLLER_CONTAINER
int SCROLLER_CONTAINER_BAR
int SCROLLER_CONTAINER_BAR_GHOST
int SCROLLER_END
int SCROLLER_SELECTION
int SCROLLER_SINGLE_TICKER
int SCROLLER_START
int SCROLLER_STYLE_DATA
int SCROLLER_STYLE_DATA_RANGE
int SCROLLER_STYLE_INDEX
int SCROLLER_STYLE_PERCENT
int VERTICAL_SCROLLER
Public Methods
abstract void addProperty(String key, String value)
Adds a new property set to the scroller bone associated to the scroller Gui Element intance.
abstract JsonGenerator getBonePropertiesGenerator()
returns the bone properties generator.
abstract String getCmdid()
Set client-side property 'cmdid'
abstract List getDataLabels()
Returns a read/write List that can be used to specify the tooltip text for each of the scroller's data points.
abstract List getDataValues()
Returns a read/write List that can be used to specify the data values for each of the scroller's data points.
abstract int getEndUnit()
Returns the end value of the scrollbar within the scroller, in relation to the maxUnits property.
abstract int getIncrement()
Gets the increment factor to be used for the scroll.
abstract int getMaxUnits()
Returns the max absolute units the scroller represents.
abstract String getScriptClass()
Returns the script class that serves as the bone for the scroller.
abstract int getSize()
abstract 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.
abstract int getStartUnit()
Returns the start value of the scrollbar within the scroller, in relation to the maxUnits property.
abstract int getStyle()
Returns the current style.
abstract int getType()
abstract boolean isSupportIncludeState()
Set flag to indicate if this scroller support toggleing its selection area between center and sides.
abstract void setCmdid(String cmdid)
abstract void setDataLabels(List dataLabels)
abstract void setEndUnit(int endUnit)
Sets the end value of the scrollbar within the scroller, in relation to the maxUnits property.
abstract void setIncrement(int increment)
Sets the increment factor to be used for the scroll.
abstract void setIsResizable(boolean isResizable)
abstract void setMaxUnits(int maxUnits)
Sets the max absolute units the scroller represents.
abstract void setMaxWindowSize(int windowSize)
abstract void setScriptClass(String scriptClass)
Sets the script class that serves as the bone for the scroller.
abstract void setSize(int size)
Sets the size of the scroller in pixels
abstract void setStartBase(int startPoint)
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.
abstract void setStartUnit(int startUnit)
Sets the start value of the scrollbar within the scroller, in relation to the maxUnits property.
abstract void setStyle(int style)
Sets the new style.
abstract void setSupportIncludeState(boolean supportIncludeState)
abstract void setType(int type)
Sets the type of scroller to display.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.gui.GuiElement

Constants

public static final int HORIZONTAL_SCROLLER

Constant Value: 0 (0x00000000)

public static final int SCROLLER_BACKGROUND

Constant Value: 4 (0x00000004)

public static final int SCROLLER_CONTAINER

Constant Value: 0 (0x00000000)

public static final int SCROLLER_CONTAINER_BAR

Constant Value: 5 (0x00000005)

public static final int SCROLLER_CONTAINER_BAR_GHOST

Constant Value: 7 (0x00000007)

public static final int SCROLLER_END

Constant Value: 3 (0x00000003)

public static final int SCROLLER_SELECTION

Constant Value: 2 (0x00000002)

public static final int SCROLLER_SINGLE_TICKER

Constant Value: 6 (0x00000006)

public static final int SCROLLER_START

Constant Value: 1 (0x00000001)

public static final int SCROLLER_STYLE_DATA

Constant Value: 0 (0x00000000)

public static final int SCROLLER_STYLE_DATA_RANGE

Constant Value: 3 (0x00000003)

public static final int SCROLLER_STYLE_INDEX

Constant Value: 1 (0x00000001)

public static final int SCROLLER_STYLE_PERCENT

Constant Value: 2 (0x00000002)

public static final int VERTICAL_SCROLLER

Constant Value: 1 (0x00000001)

Public Methods

public abstract void addProperty (String key, String value)

Adds a new property set to the scroller bone associated to the scroller Gui Element intance.

Parameters
key String
value String

public abstract JsonGenerator getBonePropertiesGenerator ()

returns the bone properties generator.

Returns

public abstract String getCmdid ()

Set client-side property 'cmdid'

public abstract 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

public abstract 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

public abstract int getEndUnit ()

Returns the end value of the scrollbar within the scroller, in relation to the maxUnits property.

Returns
  • int

public abstract 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

public abstract int getMaxUnits ()

Returns the max absolute units the scroller represents.

Returns
  • int

public abstract String getScriptClass ()

Returns the script class that serves as the bone for the scroller.

Returns
  • String.

public abstract int getSize ()

public abstract 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.

public abstract int getStartUnit ()

Returns the start value of the scrollbar within the scroller, in relation to the maxUnits property.

Returns
  • int

public abstract int getStyle ()

Returns
  • int

public abstract int getType ()

Returns

public abstract 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.

public abstract void setCmdid (String cmdid)

public abstract void setDataLabels (List dataLabels)

public abstract void setEndUnit (int endUnit)

Sets the end value of the scrollbar within the scroller, in relation to the maxUnits property.

Parameters
endUnit int

public abstract 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

public abstract void setIsResizable (boolean isResizable)

public abstract void setMaxUnits (int maxUnits)

Sets the max absolute units the scroller represents.

Parameters
maxUnits int

public abstract void setMaxWindowSize (int windowSize)

public abstract void setScriptClass (String scriptClass)

Sets the script class that serves as the bone for the scroller.

Parameters
scriptClass script class.

public abstract void setSize (int size)

Sets the size of the scroller in pixels

Parameters
size int

public abstract void setStartBase (int startPoint)

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
IllegalArgumentException Thrown when the scroller is not in style SCROLLER_STYLE_INDEX.

public abstract void setStartUnit (int startUnit)

Sets the start value of the scrollbar within the scroller, in relation to the maxUnits property.

Parameters
startUnit int

public abstract void setStyle (int style)

Parameters
style The style to set.

public abstract void setSupportIncludeState (boolean supportIncludeState)

public abstract 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