public interface

RWSelectorControl

implements RWControl
com.microstrategy.web.objects.rw.RWSelectorControl
Known Indirect Subclasses

Class Overview

Represents a selector control

Summary

Constants
int AUTO_SYNC AutoSync mode value.
int NO_AUTO_SYNC AutoSync mode value.
Public Methods
abstract RWGroupByElements createElements()
A helper method that creates an empty collection of elements.
abstract int getAutoSyncMode()
Returns AutoSync mode
abstract RWGroupByElements getCurrentElements()
Returns a collection of selected elements
abstract int getTargetType()
Returns selector target type
abstract int getUnsetCount()
Returns the unset count
abstract int getUnsetStatus()
Returns the unset status of the control
abstract void setAutoSyncMode(int value)
Sets AutoSync mode.
abstract void setTargetType(int value)
Set selector target type.
abstract void setUnsetStatus(int status, int count)
Sets the unset status of the control
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.rw.RWControl

Constants

public static final int AUTO_SYNC

AutoSync mode value. Indicates that the system shall automatically select the first available element if the current selection becomes invalid due to selection changes in other controls.

Constant Value: 3 (0x00000003)

public static final int NO_AUTO_SYNC

AutoSync mode value. Indicates that the system shall always honor user selectons

Constant Value: 2 (0x00000002)

Public Methods

public abstract RWGroupByElements createElements ()

A helper method that creates an empty collection of elements. Used for rendering controls in design mode.

Returns
  • creates an empty collection of elements

public abstract int getAutoSyncMode ()

Returns AutoSync mode

Returns
  • AutoSync mode

public abstract RWGroupByElements getCurrentElements ()

Returns a collection of selected elements

Returns
  • selected elements

public abstract int getTargetType ()

Returns selector target type

Returns
  • target type

public abstract int getUnsetCount ()

Returns the unset count

Returns
  • int number of elements to retrieve depending on status

public abstract int getUnsetStatus ()

Returns the unset status of the control

public abstract void setAutoSyncMode (int value)

Sets AutoSync mode.

public abstract void setTargetType (int value)

Set selector target type.

public abstract void setUnsetStatus (int status, int count)

Sets the unset status of the control

Parameters
status int from EnumDSSXMLRWSelectorUnsetStatus
count int number of elements to retrieve depending on status