Package com.microstrategy.web.objects.rw
Interface RWSelectorControl
-
- All Superinterfaces:
KeyedObject
,RWControl
- All Known Subinterfaces:
RWActionSelector
,RWAttributeSelector
,RWConditionSelector
,RWElementSelector
,RWMetricSelector
,RWMultiUnitSelector
,RWPanelStackControl
,RWTextSelector
,RWTransactionSelector
public interface RWSelectorControl extends RWControl
Represents a selector control- Since:
- MicroStrategy Web 8.1.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
AUTO_SYNC
AutoSync mode value.static int
NO_AUTO_SYNC
AutoSync mode value.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RWGroupByElements
createElements()
A helper method that creates an empty collection of elements.int
getAutoSyncMode()
Returns AutoSync modeRWGroupByElements
getCurrentElements()
Returns a collection of selected elementsboolean
getSduc()
Returns selector dynamic unit conditionint
getTargetType()
Returns selector target typeint
getUnsetCount()
Returns the unset countint
getUnsetStatus()
Returns the unset status of the controlvoid
setAutoSyncMode(int value)
Sets AutoSync mode.void
setTargetType(int value)
Set selector target type.void
setUnsetStatus(int status, int count)
Sets the unset status of the control-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.web.objects.rw.RWControl
addDatasetTarget, addDatasetTarget, addPlaceHolderTarget, addTarget, addTarget, canMultiSelect, canUseSubtotals, generateGridControlFormatDelta, getDatasetTargets, getGroupByTargetKeys, getInfoWindowTarget, getKey, getKeyContext, getParent, getPlaceHolderGroupByTargetKeys, getPlaceHolderTargets, getSubtotals, getTarget, getTargetCount, getTargets, getTransactionAction, getType, hasDatasetTarget, hasTarget, hasTargets, isShowAll, isTopMost, isUnset, removeAllDatasetTargets, removeDatasetTarget, removePlaceHolderTarget, removeTarget, setInfoWindowTarget, setShowAll, setTopMost
-
-
-
-
Field Detail
-
NO_AUTO_SYNC
static final int NO_AUTO_SYNC
AutoSync mode value. Indicates that the system shall always honor user selectons- Since:
- MicroStrategy Web 8.1.1
- See Also:
- Constant Field Values
-
AUTO_SYNC
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.- Since:
- MicroStrategy Web 8.1.1
- See Also:
- Constant Field Values
-
-
Method Detail
-
getCurrentElements
RWGroupByElements getCurrentElements()
Returns a collection of selected elements- Returns:
- selected elements
-
createElements
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
-
getAutoSyncMode
int getAutoSyncMode()
Returns AutoSync mode- Returns:
- AutoSync mode
- Since:
- MicroStrategy Web 8.1.1
-
setAutoSyncMode
void setAutoSyncMode(int value)
Sets AutoSync mode.- Parameters:
value
-- Since:
- MicroStrategy Web 8.1.1
-
setUnsetStatus
void setUnsetStatus(int status, int count)
Sets the unset status of the control- Parameters:
status
- int fromEnumDSSXMLRWSelectorUnsetStatus
count
- int number of elements to retrieve depending on status
-
getUnsetStatus
int getUnsetStatus()
Returns the unset status of the control- Returns:
- int from
EnumDSSXMLRWSelectorUnsetStatus
-
getUnsetCount
int getUnsetCount()
Returns the unset count- Returns:
- int number of elements to retrieve depending on status
-
setTargetType
void setTargetType(int value)
Set selector target type.- Specified by:
setTargetType
in interfaceRWControl
- Parameters:
value
-- Since:
- MicroStrategy Web 9.3
-
getTargetType
int getTargetType()
Returns selector target type- Specified by:
getTargetType
in interfaceRWControl
- Returns:
- target type
-
getSduc
boolean getSduc()
Returns selector dynamic unit condition
-
-