public interface

RWControlDef

implements RWUnitDef
com.microstrategy.web.objects.rw.RWControlDef

Class Overview

Represents a difinition of the actionable control document unit

Summary

Public Methods
abstract boolean canMultiSelect()
Returns true if control can support multiple selections.
abstract boolean canSingleSelect()
Returns true if control can support single selections.
abstract String getAllAlias()
Returns alias to be used for Select All option
abstract int getAutoSyncMode()
Returns AutoSync mode
abstract RWControl getControl()
Returns control associated with this unit
abstract String getControlNodeKey()
Returns control node key
abstract WebThresholds getControlNodeThresholds()
Returns the Thresholds associated with the node of action selector.
abstract boolean getInclude()
Returns control selection include/exclude mode.
abstract int getItemWidthMode()
Returns item width mode.
abstract int getMouseOverAction()
Returns control mouse over action.
abstract int getOrientation()
Gets control orientation
abstract int getOrientationBehavior()
Gets control orientation behavior
abstract int getStyle()
Gets control style (see EnumRWControlStyle)
abstract boolean isMultiSelect()
Returns true if control allows multiple selections
abstract boolean isShowAll()
Returns true if control displays the Select All option and supports selecting all elements
abstract void setAllAlias(String value)
Sets alias to be used for Select All option
abstract void setAutoSyncMode(int value)
Sets AutoSync mode.
abstract void setControlTargteType(int newTargteType)
Sets control target type
abstract void setControlType(int newType)
Sets control type
abstract void setItemWidthMode(int value)
Sets item width mode.
abstract void setMouseOverAction(int value)
Sets control mouse over action.
abstract void setMultiSelect(boolean value)
Sets multi-select mode
abstract void setOrientation(int value)
Sets control orientation
abstract void setOrientationBehavior(int value)
Sets control orientation behavior
abstract void setShowAll(boolean value)
Sets Show All option
abstract void setStyle(int value)
Sets control style
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebThresholdsContainer
From interface com.microstrategy.web.objects.rw.RWUnitDef

Public Methods

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

public abstract boolean canSingleSelect ()

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

Returns
  • boolean

public abstract String getAllAlias ()

Returns alias to be used for Select All option

Returns
  • alias to be used for Select All option

public abstract int getAutoSyncMode ()

Returns AutoSync mode

Returns
  • AutoSync mode

public abstract RWControl getControl ()

Returns control associated with this unit

Returns
  • control associated with this unit

public abstract String getControlNodeKey ()

Returns control node key

Returns
  • control node key

public abstract WebThresholds getControlNodeThresholds ()

Returns the Thresholds associated with the node of action selector.

Returns

public abstract boolean getInclude ()

Returns control selection include/exclude mode.

Returns
  • include/exclude mode

public abstract int getItemWidthMode ()

Returns item width mode.

Returns

public abstract int getMouseOverAction ()

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

Returns
  • control mouse over action

public abstract int getOrientation ()

Gets control orientation

Returns

public abstract int getOrientationBehavior ()

Gets control orientation behavior

Returns
  • control orientation behavior

public abstract int getStyle ()

Gets control style (see EnumRWControlStyle)

Returns
  • control style

public abstract boolean isMultiSelect ()

Returns true if control allows multiple selections

Returns
  • true if control allows multiple selections

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

public abstract void setAllAlias (String value)

Sets alias to be used for Select All option

Parameters
value alias

public abstract void setAutoSyncMode (int value)

Sets AutoSync mode.

public abstract void setControlTargteType (int newTargteType)

Sets control target type

public abstract void setControlType (int newType)

Sets control type

Parameters
newType control type

public abstract void setItemWidthMode (int value)

Sets item width mode.

Parameters
value item width mod (see EnumRWItemWidthMode)

public abstract void setMouseOverAction (int value)

Sets control mouse over action. (Used for Flash only).

Parameters
value mouse over action.

public abstract void setMultiSelect (boolean value)

Sets multi-select mode

Parameters
value if true, then control will allow multiple selections.

public abstract void setOrientation (int value)

Sets control orientation

Parameters
value orientation (see EnumRWOrientation).

public abstract void setOrientationBehavior (int value)

Sets control orientation behavior

Parameters
value orientation behavior

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

public abstract void setStyle (int value)

Sets control style

Parameters
value control style (see EnumRWControlStyle)