public class

ScrollerImpl

extends AbstractGuiElement
implements Scroller
java.lang.Object
   ↳ com.microstrategy.web.app.gui.AbstractGuiElement
     ↳ com.microstrategy.web.app.gui.ScrollerImpl

Class Overview

ScrollerImpl abstraction it renders an HMTL output for a Scroller Gui Element.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.gui.Scroller
[Expand]
Inherited Fields
From class com.microstrategy.web.app.gui.AbstractGuiElement
Public Methods
void addProperty(String key, String value)
Adds a new property set to the scroller bone associated to the scroller Gui Element intance.
JsonGenerator getBonePropertiesGenerator()
returns the bone properties generator.
String getCSSName(int section)
String getCmdid()
Set client-side property 'cmdid'
List getDataLabels()
Returns a read/write List that can be used to specify the tooltip text for each of the scroller's data points.
List getDataValues()
Returns a read/write List that can be used to specify the data values for each of the scroller's data points.
int getEndUnit()
Returns the end value of the scrollbar within the scroller, in relation to the maxUnits property.
int getIncrement()
Gets the increment factor to be used for the scroll.
int getMaxUnits()
Returns the max absolute units the scroller represents.
String getScriptClass()
Returns the script class that serves as the bone for the scroller.
int getSize()
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.
int getStartUnit()
Returns the start value of the scrollbar within the scroller, in relation to the maxUnits property.
int getStyle()
Returns the current style.
int getType()
boolean isSupportIncludeState()
Set flag to indicate if this scroller support toggleing its selection area between center and sides.
MarkupOutput renderElement()
render the gui element in a MarkupOutput object
void renderScroller(MarkupOutput out, int type)
void setCmdid(String cmdid)
void setDataLabels(List dataLabels)
void setEndUnit(int endUnit)
Sets the end value of the scrollbar within the scroller, in relation to the maxUnits property.
void setIncrement(int increment)
Sets the increment factor to be used for the scroll.
void setIsResizable(boolean isResizable)
void setMaxUnits(int maxUnits)
Sets the max absolute units the scroller represents.
void setMaxWindowSize(int windowSize)
void setScriptClass(String _scriptClass)
Sets the script class that serves as the bone for the scroller.
void setSize(int size)
Sets the size of the scroller in pixels
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.
void setStartUnit(int startUnit)
Sets the start value of the scrollbar within the scroller, in relation to the maxUnits property.
void setStyle(int style)
Sets the new style.
void setSupportIncludeState(boolean supportIncludeState)
void setType(int type)
Sets the type of scroller to display.
Protected Methods
ClientSideHelper getClientSideHelper()
Returns the ClientSideHelper instance associated with the scroller.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.gui.AbstractGuiElement
From class java.lang.Object
From interface com.microstrategy.web.app.gui.GuiElement
From interface com.microstrategy.web.app.gui.Scroller

Public Methods

public 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 JsonGenerator getBonePropertiesGenerator ()

returns the bone properties generator.

Returns

public String getCSSName (int section)

Parameters
section int Scroller's section. Possible values:
Returns

public String getCmdid ()

Set client-side property 'cmdid'

public 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 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 int getEndUnit ()

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

Returns
  • int

public 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 int getMaxUnits ()

Returns the max absolute units the scroller represents.

Returns
  • int

public String getScriptClass ()

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

Returns
  • String.

public int getSize ()

public 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 int getStartUnit ()

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

Returns
  • int

public int getStyle ()

Returns
  • int

public int getType ()

public 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 MarkupOutput renderElement ()

render the gui element in a MarkupOutput object

Returns

public void renderScroller (MarkupOutput out, int type)

public void setCmdid (String cmdid)

public void setDataLabels (List dataLabels)

public void setEndUnit (int endUnit)

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

Parameters
endUnit int

public 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 void setIsResizable (boolean isResizable)

public void setMaxUnits (int maxUnits)

Sets the max absolute units the scroller represents.

Parameters
maxUnits int

public void setMaxWindowSize (int windowSize)

public void setScriptClass (String _scriptClass)

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

Parameters
_scriptClass script class.

public void setSize (int size)

Sets the size of the scroller in pixels

Parameters
size int

public 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

public void setStartUnit (int startUnit)

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

Parameters
startUnit int

public void setStyle (int style)

Parameters
style The style to set.

public void setSupportIncludeState (boolean supportIncludeState)

public 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

Protected Methods

protected ClientSideHelper getClientSideHelper ()

Returns the ClientSideHelper instance associated with the scroller. This ClientSideHelper is used by the scroller to register the scroller bone.

Returns
  • ClientSideHelper