RWControl
implements KeyedObject| com.microstrategy.web.objects.rw.RWControl |
 Known Indirect Subclasses
|
Class Overview
Represents a definition of the actionable control.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
addDatasetTarget(String did, int sourceType)
Adds specified data set as this control target
| ||||||||||
| abstract void |
addDatasetTarget(String did)
Adds specified data set as this control target
| ||||||||||
| abstract void |
addPlaceHolderTarget(String key, Set<Integer> indices)
Add the specified place holder as the control target.
| ||||||||||
| abstract void | addTarget(String key, String cgbKey) | ||||||||||
| abstract void |
addTarget(String key)
Adds specified unt as this control target
| ||||||||||
| abstract boolean |
canMultiSelect()
Returns true if this control supports multi-select mode
| ||||||||||
| abstract boolean | canUseSubtotals() | ||||||||||
| abstract void |
generateGridControlFormatDelta()
generate the delta for grid control format
| ||||||||||
| abstract List<String> |
getDatasetTargets()
Get all control data sets targets
| ||||||||||
| abstract String[] |
getGroupByTargetKeys()
Returns array of target control group by keys
| ||||||||||
| abstract String |
getInfoWindowTarget()
Get information window target
| ||||||||||
| abstract String |
getKey()
Returns control key
| ||||||||||
| abstract String |
getKeyContext()
Returns the control key in the server-specific format.
| ||||||||||
| abstract RWUnitDef | getParent() | ||||||||||
| abstract String[] |
getPlaceHolderGroupByTargetKeys()
Returns an array of group by target keys for the place holders.
| ||||||||||
| abstract Map<String, Set<Integer>> |
getPlaceHolderTargets()
Returns the place holders targeted by this control.
| ||||||||||
| abstract RWSubtotals | getSubtotals() | ||||||||||
| abstract RWUnitDef |
getTarget(int i)
Returns i-th target
| ||||||||||
| abstract int |
getTargetCount()
Returns number of control targets
| ||||||||||
| abstract int |
getTargetType()
Get Target type
| ||||||||||
| abstract Enumeration |
getTargets()
Returns enumeration over all control targets
| ||||||||||
| abstract int |
getTransactionAction()
return transactionAction EnumDSSXMLTransactionAction
| ||||||||||
| abstract int |
getType()
Returns control type {see
EnumDSSXMLRWControlType} | ||||||||||
| abstract boolean |
hasDatasetTarget(String did)
Checks if specified data set is a this control's target
| ||||||||||
| abstract boolean |
hasTarget(String key)
Checks if specified unit is a this control's target
| ||||||||||
| abstract boolean |
hasTargets()
Returns true if the given selector has targets.
| ||||||||||
| abstract boolean |
isShowAll()
Returns true if the show all option is on
| ||||||||||
| abstract boolean |
isTopMost()
return isTopMost
| ||||||||||
| abstract boolean | isUnset() | ||||||||||
| abstract void |
removeAllDatasetTargets()
Remove all control data sets targets
| ||||||||||
| abstract void |
removeDatasetTarget(String did)
removes specified data set as this control target
| ||||||||||
| abstract void |
removePlaceHolderTarget(String key, Set<Integer> indices)
Remove the specified place holder from the control targets.
| ||||||||||
| abstract void |
removeTarget(String key)
Removes specified unit from control targets
| ||||||||||
| abstract void |
setInfoWindowTarget(String targetKey)
Set the specified panel stack as the control information window target
| ||||||||||
| abstract void |
setShowAll(boolean value)
Sets show all option
| ||||||||||
| abstract void |
setTargetType(int value)
Set target type is document(0)/data set(1)
| ||||||||||
| abstract void |
setTopMost(boolean _isTopMost)
set isTopMost property
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.KeyedObject
| |||||||||||
Public Methods
public abstract void addDatasetTarget (String did, int sourceType)
Adds specified data set as this control target
Parameters
| did | of data set |
|---|---|
| sourceType | of the data set |
public abstract void addDatasetTarget (String did)
Adds specified data set as this control target
Parameters
| did | of data set |
|---|
public abstract void addPlaceHolderTarget (String key, Set<Integer> indices)
Add the specified place holder as the control target.
Parameters
| key | node key of the template where the place holder is defined on |
|---|---|
| indices | set of place holder indices to be added |
Throws
| WebObjectsException |
|---|
public abstract void addTarget (String key)
public abstract boolean canMultiSelect ()
Returns true if this control supports multi-select mode
Returns
- true if this control supports multi-select mode
public abstract boolean canUseSubtotals ()
public abstract void generateGridControlFormatDelta ()
generate the delta for grid control format
public abstract List<String> getDatasetTargets ()
Get all control data sets targets
public abstract String[] getGroupByTargetKeys ()
Returns array of target control group by keys
public abstract String getInfoWindowTarget ()
Get information window target
Returns
- information window target key
public abstract String getKey ()
Returns control key
Returns
- control key
public abstract 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
public abstract String[] getPlaceHolderGroupByTargetKeys ()
Returns an array of group by target keys for the place holders.
Returns
- An array of place holder group by target keys.
public abstract Map<String, Set<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
public abstract RWUnitDef getTarget (int i)
Returns i-th target
Parameters
| i | index |
|---|
Returns
- i-th target
public abstract int getTargetCount ()
Returns number of control targets
Returns
- number of control targets
public abstract int getTargetType ()
Get Target type
Returns
- target type
public abstract Enumeration getTargets ()
Returns enumeration over all control targets
Returns
- enumeration over all control targets
public abstract int getTransactionAction ()
return transactionAction EnumDSSXMLTransactionAction
Returns
- transactionAction EnumDSSXMLTransactionAction
public abstract int getType ()
Returns control type {see EnumDSSXMLRWControlType}
Returns
- control typ
public abstract boolean hasDatasetTarget (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
public abstract boolean hasTarget (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
public abstract boolean hasTargets ()
Returns true if the given selector has targets. Please notice that because of partial
display functionality it is possible that the getTarget(int)
method will return 0 event if this method returns true.
public abstract boolean isShowAll ()
Returns true if the show all option is on
Returns
- true if the show all option is on
public abstract boolean isTopMost ()
return isTopMost
public abstract boolean isUnset ()
public abstract void removeAllDatasetTargets ()
Remove all control data sets targets
public abstract void removeDatasetTarget (String did)
removes specified data set as this control target
Parameters
| did | of data set |
|---|
public abstract void removePlaceHolderTarget (String key, Set<Integer> indices)
Remove the specified place holder from the control targets.
Parameters
| key | node key of the template where the place holder is defined on |
|---|
public abstract void removeTarget (String key)
Removes specified unit from control targets
Parameters
| key | target unit key |
|---|
Throws
| WebObjectsException |
|---|
public abstract void setInfoWindowTarget (String targetKey)
Set the specified panel stack as the control information window target
Parameters
| targetKey | node key of target information window |
|---|
Throws
| IllegalArgumentException |
|---|
public abstract void setShowAll (boolean value)
Sets show all option
Parameters
| value | show all option |
|---|
public abstract void setTargetType (int value)
Set target type is document(0)/data set(1)
public abstract void setTopMost (boolean _isTopMost)
set isTopMost property