RWUnitDef
implements WebThresholdsContainer| com.microstrategy.web.objects.rw.RWUnitDef |
 Known Indirect Subclasses
|
Class Overview
A root interface for all definition units
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
copyFormat(RWUnitDef fromUnit)
Copies formatting properties from the fromUnit to this unit.
| ||||||||||
| abstract void |
flushFormatChanges(boolean applyToAllViews)
flush the current formatting manipulations, so that it would be submitted to iserver if needed.
| ||||||||||
| abstract List |
getAllControlGroupBys()
Returns a list of all the controlGroupBys
RWControlGroupBy on this unit
including element selector and metric selector targeting control groupBys | ||||||||||
| abstract RWControlGroupBys |
getElementControlGroupBys()
Returns a
RWControlGroupBys object, which is a collection of
all element selection RWControlGroupBy objects | ||||||||||
| abstract FilterDetailsFormatting | getFilterDetailsFormatting() | ||||||||||
| abstract WebFormat |
getFormat(int formatType)
Returns a format object for the given format type.
| ||||||||||
| abstract WebFormat | getFormat(String id) | ||||||||||
| abstract WebFormat |
getFormat()
Returns formatting object
| ||||||||||
| abstract int[] |
getFormatTypes()
Returns a list of format types applicable to the given object
| ||||||||||
| abstract String |
getKey()
Returns unit ID
| ||||||||||
| abstract String |
getKeyContext()
Returns a unique id to be used by the backend to identify any unit.
| ||||||||||
| abstract String |
getName()
This is a convenience method for reading the name of the object
This is equivalent to reading the name property from the FormattingAppearance propertySet
of the format definition associated with this object
| ||||||||||
| abstract RWSectionDef |
getParent()
Returns unit's parent
| ||||||||||
| abstract RWDefinition |
getRwDefinition()
Returns parent RwDefiniton
| ||||||||||
| abstract WebTheme | getTheme() | ||||||||||
| abstract RWThreshold |
getThreshold(int i)
This method is deprecated.
use
get(int) via getThresholds()
| ||||||||||
| abstract RWThreshold |
getThreshold(String id)
This method is deprecated.
use
get(String) via getThresholds()
| ||||||||||
| abstract int |
getThresholdCount()
This method is deprecated.
use
size() via getThresholds()
| ||||||||||
| abstract String | getTreeType() | ||||||||||
| abstract int |
getType()
Returns unit type
| ||||||||||
| abstract boolean |
isFirst()
Returns true if this unit is the first on its parent collection
| ||||||||||
| abstract boolean |
isLast()
Returns true if this unit is the last on its parent collection
| ||||||||||
| abstract boolean |
isVisible()
Retyrns true if this unit is visible
| ||||||||||
| abstract RWUnitDef |
nextSibling()
Returns next sibleng
| ||||||||||
| abstract RWUnitDef |
prevSibling()
Returns previous sibling
| ||||||||||
| abstract void |
revertToFormatDefaults()
Resets the unit's format to the control default values
| ||||||||||
| abstract void |
setName(String name)
This is a convenience method for setting the name of the object
This is equivalent to setting the name property from the FormattingAppearance propertySet
of the format definition associated with this object
| ||||||||||
| abstract void |
setVisible(boolean value)
Sets visible property on the unit
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.web.objects.WebThresholdsContainer
| |||||||||||
Public Methods
public abstract void copyFormat (RWUnitDef fromUnit)
Copies formatting properties from the fromUnit to this unit. This method copies only subset of properties, which is determined by the list of "copyable" properties. There is a separate list of copyable properties for each unit type. Those lists are stored in metadata.
Parameters
| fromUnit | a unit from which formatting propertis will be copied |
|---|
Throws
| WebObjectsException |
|---|
public abstract void flushFormatChanges (boolean applyToAllViews)
flush the current formatting manipulations, so that it would be submitted to iserver if needed. If @param applyToAllViews is true, the formatting would be applied to all views, other wise the current view.
public abstract List getAllControlGroupBys ()
Returns a list of all the controlGroupBys RWControlGroupBy on this unit
including element selector and metric selector targeting control groupBys
public abstract RWControlGroupBys getElementControlGroupBys ()
Returns a RWControlGroupBys object, which is a collection of
all element selection RWControlGroupBy objects
public abstract WebFormat getFormat (int formatType)
Returns a format object for the given format type.
Parameters
| formatType | format type |
|---|
Returns
- WebFormat
public abstract WebFormat getFormat (String id)
This method is deprecated.
use getFormat() via getThresholds() and get(String)
Returns format of the threshold with specified ID
Parameters
| id | threshold ID |
|---|
Returns
- threshold format
public abstract int[] getFormatTypes ()
Returns a list of format types applicable to the given object
Returns
- int[]
public abstract String getKey ()
Returns unit ID
Returns
- unit ID
public abstract String getKeyContext ()
Returns a unique id to be used by the backend to identify any unit.
Returns
- unique identifier
public abstract String getName ()
This is a convenience method for reading the name of the object This is equivalent to reading the name property from the FormattingAppearance propertySet of the format definition associated with this object
Returns
- name
public abstract RWDefinition getRwDefinition ()
Returns parent RwDefiniton
Returns
- parent RwDefiniton
public abstract RWThreshold getThreshold (int i)
This method is deprecated.
use get(int) via getThresholds()
Returns i-th threshold
Parameters
| i | index |
|---|
Returns
- RWThreshold i-th threshold
public abstract RWThreshold getThreshold (String id)
This method is deprecated.
use get(String) via getThresholds()
Returns threshold by its ID
Parameters
| id | threshold ID |
|---|
Returns
- threshold
public abstract int getThresholdCount ()
This method is deprecated.
use size() via getThresholds()
Returns number of thresholds on the unit
Returns
- number of thresholds on the unit
public abstract String getTreeType ()
public abstract int getType ()
Returns unit type
Returns
- unit type
public abstract boolean isFirst ()
Returns true if this unit is the first on its parent collection
Returns
- true if this unit is the first on its parent collection
public abstract boolean isLast ()
Returns true if this unit is the last on its parent collection
Returns
- true if this unit is the last on its parent collection
public abstract boolean isVisible ()
Retyrns true if this unit is visible
Returns
- true if this unit is visible
Throws
| WebObjectsException |
|---|
public abstract void revertToFormatDefaults ()
Resets the unit's format to the control default values
public abstract void setName (String name)
This is a convenience method for setting the name of the object This is equivalent to setting the name property from the FormattingAppearance propertySet of the format definition associated with this object
public abstract void setVisible (boolean value)
Sets visible property on the unit
Parameters
| value | if value is false the unit will not be visible |
|---|
Throws
| WebObjectsException |
|---|