Package com.microstrategy.web.objects.rw
Interface RWControl
-
- All Superinterfaces:
KeyedObject
- All Known Subinterfaces:
RWActionSelector
,RWAttributeSelector
,RWConditionSelector
,RWElementSelector
,RWMetricSelector
,RWMultiUnitSelector
,RWPanelStackControl
,RWSelectorControl
,RWTextSelector
,RWTransactionSelector
public interface RWControl extends KeyedObject
Represents a definition of the actionable control.- Since:
- MicroStrategy Web 8.1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addDatasetTarget(java.lang.String did)
Adds specified data set as this control targetvoid
addDatasetTarget(java.lang.String did, int sourceType)
Adds specified data set as this control targetvoid
addPlaceHolderTarget(java.lang.String key, java.util.Set<java.lang.Integer> indices)
Add the specified place holder as the control target.void
addTarget(java.lang.String key)
Adds specified unt as this control targetvoid
addTarget(java.lang.String key, java.lang.String cgbKey)
boolean
canMultiSelect()
Returns true if this control supports multi-select modeboolean
canUseSubtotals()
void
generateGridControlFormatDelta()
generate the delta for grid control formatjava.util.List<java.lang.String>
getDatasetTargets()
Get all control data sets targetsjava.lang.String[]
getGroupByTargetKeys()
Returns array of target control group by keysjava.lang.String
getInfoWindowTarget()
Get information window targetjava.lang.String
getKey()
Returns control keyjava.lang.String
getKeyContext()
Returns the control key in the server-specific format.RWUnitDef
getParent()
java.lang.String[]
getPlaceHolderGroupByTargetKeys()
Returns an array of group by target keys for the place holders.java.util.Map<java.lang.String,java.util.Set<java.lang.Integer>>
getPlaceHolderTargets()
Returns the place holders targeted by this control.RWSubtotals
getSubtotals()
RWUnitDef
getTarget(int i)
Returns i-th targetint
getTargetCount()
Returns number of control targetsjava.util.Enumeration
getTargets()
Returns enumeration over all control targetsint
getTargetType()
Get Target typeint
getTransactionAction()
return transactionActionEnumDSSXMLTransactionAction
int
getType()
Returns control type {seeEnumDSSXMLRWControlType
}boolean
hasDatasetTarget(java.lang.String did)
Checks if specified data set is a this control's targetboolean
hasTarget(java.lang.String key)
Checks if specified unit is a this control's targetboolean
hasTargets()
Returns true if the given selector has targets.boolean
isShowAll()
Returns true if the show all option is onboolean
isTopMost()
return isTopMostboolean
isUnset()
void
removeAllDatasetTargets()
Remove all control data sets targetsvoid
removeDatasetTarget(java.lang.String did)
removes specified data set as this control targetvoid
removePlaceHolderTarget(java.lang.String key, java.util.Set<java.lang.Integer> indices)
Remove the specified place holder from the control targets.void
removeTarget(java.lang.String key)
Removes specified unit from control targetsvoid
setInfoWindowTarget(java.lang.String targetKey)
Set the specified panel stack as the control information window targetvoid
setShowAll(boolean value)
Sets show all optionvoid
setTargetType(int value)
Set target type is document(0)/data set(1)void
setTopMost(boolean _isTopMost)
set isTopMost property-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
-
-
-
Method Detail
-
getKey
java.lang.String getKey()
Returns control key- Returns:
- control key
-
getType
int getType()
Returns control type {seeEnumDSSXMLRWControlType
}- Returns:
- control typ
-
getTargetCount
int getTargetCount()
Returns number of control targets- Returns:
- number of control targets
-
getTarget
RWUnitDef getTarget(int i)
Returns i-th target- Parameters:
i
- index- Returns:
- i-th target
-
getGroupByTargetKeys
java.lang.String[] getGroupByTargetKeys()
Returns array of target control group by keys- Since:
- MicroStrategy Web 9.0.1
-
getTargets
java.util.Enumeration getTargets()
Returns enumeration over all control targets- Returns:
- enumeration over all control targets
-
addDatasetTarget
void addDatasetTarget(java.lang.String did)
Adds specified data set as this control target- Parameters:
did
- of data set
-
addDatasetTarget
void addDatasetTarget(java.lang.String did, int sourceType)
Adds specified data set as this control target- Parameters:
did
- of data setsourceType
- of the data set
-
removeDatasetTarget
void removeDatasetTarget(java.lang.String did)
removes specified data set as this control target- Parameters:
did
- of data set
-
hasDatasetTarget
boolean hasDatasetTarget(java.lang.String did)
Checks if specified data set is a this control's target- Parameters:
did
- of data set- Returns:
- true if the data set is present among this control targets
-
getDatasetTargets
java.util.List<java.lang.String> getDatasetTargets()
Get all control data sets targets
-
removeAllDatasetTargets
void removeAllDatasetTargets()
Remove all control data sets targets
-
setTargetType
void setTargetType(int value)
Set target type is document(0)/data set(1)- Parameters:
target
- type
-
getTargetType
int getTargetType()
Get Target type- Returns:
- target type
-
addTarget
void addTarget(java.lang.String key) throws WebObjectsException
Adds specified unt as this control target- Parameters:
key
- target unit key- Throws:
WebObjectsException
-
addTarget
void addTarget(java.lang.String key, java.lang.String cgbKey) throws WebObjectsException
- Throws:
WebObjectsException
-
removeTarget
void removeTarget(java.lang.String key) throws WebObjectsException
Removes specified unit from control targets- Parameters:
key
- target unit key- Throws:
WebObjectsException
-
hasTarget
boolean hasTarget(java.lang.String key)
Checks if specified unit is a this control's target- Parameters:
key
- unit key- Returns:
- true if the unit is present among this control targets
-
canMultiSelect
boolean canMultiSelect()
Returns true if this control supports multi-select mode- Returns:
- true if this control supports multi-select mode
-
isShowAll
boolean isShowAll()
Returns true if the show all option is on- Returns:
- true if the show all option is on
-
setShowAll
void setShowAll(boolean value)
Sets show all option- Parameters:
value
- show all option
-
getKeyContext
java.lang.String getKeyContext()
Returns the control key in the server-specific format. This method is used to optimize the Set Current Element events as this key format allows executing these events without reloading document defintion.- Returns:
- the control key in the server-specific format
-
canUseSubtotals
boolean canUseSubtotals()
- Since:
- MicroStrategy Web 9.0.0
-
getSubtotals
RWSubtotals getSubtotals()
- Since:
- MicroStrategy Web 9.0.0
-
hasTargets
boolean hasTargets()
Returns true if the given selector has targets. Please notice that because of partial display functionality it is possible that thegetTarget(int)
method will return 0 event if this method returns true.- Since:
- MicroStrategy Web 9.0.1
-
isUnset
boolean isUnset()
- Since:
- MicroStrategy Web 9.0.1
-
addPlaceHolderTarget
void addPlaceHolderTarget(java.lang.String key, java.util.Set<java.lang.Integer> indices) throws WebObjectsException
Add the specified place holder as the control target.- Parameters:
key
- node key of the template where the place holder is defined onindices
- set of place holder indices to be added- Throws:
WebObjectsException
-
removePlaceHolderTarget
void removePlaceHolderTarget(java.lang.String key, java.util.Set<java.lang.Integer> indices)
Remove the specified place holder from the control targets.- Parameters:
key
- node key of the template where the place holder is defined onindex
- set of place holder indices to be removed
-
getPlaceHolderTargets
java.util.Map<java.lang.String,java.util.Set<java.lang.Integer>> getPlaceHolderTargets()
Returns the place holders targeted by this control.- Returns:
- An immutable collection of place holders, which maps the template node key to a set of place holder indices
-
getPlaceHolderGroupByTargetKeys
java.lang.String[] getPlaceHolderGroupByTargetKeys()
Returns an array of group by target keys for the place holders.- Returns:
- An array of place holder group by target keys.
-
getTransactionAction
int getTransactionAction()
return transactionActionEnumDSSXMLTransactionAction
- Returns:
- transactionAction
EnumDSSXMLTransactionAction
-
getParent
RWUnitDef getParent()
- Returns:
- parent
-
setInfoWindowTarget
void setInfoWindowTarget(java.lang.String targetKey) throws java.lang.IllegalArgumentException
Set the specified panel stack as the control information window target- Parameters:
targetKey
- node key of target information window- Throws:
java.lang.IllegalArgumentException
-
getInfoWindowTarget
java.lang.String getInfoWindowTarget()
Get information window target- Returns:
- information window target key
-
generateGridControlFormatDelta
void generateGridControlFormatDelta()
generate the delta for grid control format
-
setTopMost
void setTopMost(boolean _isTopMost)
set isTopMost property- Parameters:
_isTopMost
-
-
isTopMost
boolean isTopMost()
return isTopMost
-
-