All Superinterfaces:

WebThresholdsContainer

All Known Subinterfaces:

RWControlDef, RWFieldDef, RWFieldGroupDef, RWGridGraphDef, RWHTMLDef, RWImageDef, RWLayoutSectionDef, RWLineDef, RWPanelStackDef, RWSectionDef, RWShapeDef, RWSubsectionDef, RWTextDef
```
public interface RWUnitDef
extends WebThresholdsContainer
```
A root interface for all definition units

Since:

MicroStrategy Web 8.0.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`copyFormat(RWUnitDef fromUnit)`	Copies formatting properties from the fromUnit to this unit.
`void`	`flushFormatChanges(boolean applyToAllViews)`	flush the current formatting manipulations, so that it would be submitted to iserver if needed.
`java.util.List`	`getAllControlGroupBys()`	Returns a list of all the controlGroupBys `RWControlGroupBy` on this unit including element selector and metric selector targeting control groupBys
`RWControlGroupBys`	`getElementControlGroupBys()`	Returns a `RWControlGroupBys` object, which is a collection of all element selection `RWControlGroupBy` objects
`FilterDetailsFormatting`	`getFilterDetailsFormatting()`
`WebFormat`	`getFormat()`	Returns formatting object
`WebFormat`	`getFormat(int formatType)`	Returns a format object for the given format type.
`WebFormat`	`getFormat(java.lang.String id)`	Deprecated. use `WebThreshold.getFormat()` via `WebThresholdsContainer.getThresholds()` and `WebThresholds.get(String)`
`int[]`	`getFormatTypes()`	Returns a list of format types applicable to the given object
`java.lang.String`	`getKey()`	Returns unit ID
`java.lang.String`	`getKeyContext()`	Returns a unique id to be used by the backend to identify any unit.
`java.lang.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
`RWSectionDef`	`getParent()`	Returns unit's parent
`RWDefinition`	`getRwDefinition()`	Returns parent RwDefiniton
`WebTheme`	`getTheme()`
`RWThreshold`	`getThreshold(int i)`	Deprecated. use `WebThresholds.get(int)` via `WebThresholdsContainer.getThresholds()`
`RWThreshold`	`getThreshold(java.lang.String id)`	Deprecated. use `WebThresholds.get(String)` via `WebThresholdsContainer.getThresholds()`
`int`	`getThresholdCount()`	Deprecated. use `WebThresholds.size()` via `WebThresholdsContainer.getThresholds()`
`java.lang.String`	`getTreeType()`
`int`	`getType()`	Returns unit type
`boolean`	`isFirst()`	Returns true if this unit is the first on its parent collection
`boolean`	`isLast()`	Returns true if this unit is the last on its parent collection
`boolean`	`isVisible()`	Retyrns true if this unit is visible
`RWUnitDef`	`nextSibling()`	Returns next sibleng
`RWUnitDef`	`prevSibling()`	Returns previous sibling
`void`	`revertToFormatDefaults()`	Resets the unit's format to the control default values
`void`	`setName(java.lang.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
`void`	`setVisible(boolean value)`	Sets visible property on the unit

Methods inherited from interface com.microstrategy.web.objects.WebThresholdsContainer
getID, getObjectType, getThresholds, getTransactions, initElementSource

- Method Detail
  - getType
```
int getType()
```
    Returns unit type
    
    Specified by:
    
    getType in interface WebThresholdsContainer
    
    Returns:
    
    unit type
  - getKey
```
java.lang.String getKey()
```
    Returns unit ID
    
    Returns:
    
    unit ID
  - getRwDefinition
```
RWDefinition getRwDefinition()
```
    Returns parent RwDefiniton
    
    Returns:
    
    parent RwDefiniton
  - getParent
```
RWSectionDef getParent()
```
    Returns unit's parent
    
    Returns:
    
    unit's parent
  - getFormat
```
WebFormat getFormat()
```
    Returns formatting object
    
    Specified by:
    
    getFormat in interface WebThresholdsContainer
    
    Returns:
    
    formatting object
  - copyFormat
```
void copyFormat(RWUnitDef fromUnit)
         throws WebObjectsException
```
    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
  - isFirst
```
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
  - isLast
```
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
  - nextSibling
```
RWUnitDef nextSibling()
```
    Returns next sibleng
    
    Returns:
    
    next sibleng
  - prevSibling
```
RWUnitDef prevSibling()
```
    Returns previous sibling
    
    Returns:
    
    previous sibling
  - isVisible
```
boolean isVisible()
           throws WebObjectsException
```
    Retyrns true if this unit is visible
    
    Returns:
    
    true if this unit is visible
    
    Throws:
    
    WebObjectsException
  - setVisible
```
void setVisible(boolean value)
         throws WebObjectsException
```
    Sets visible property on the unit
    
    Parameters:
    
    value - if value is false the unit will not be visible
    
    Throws:
    
    WebObjectsException
  - revertToFormatDefaults
```
void revertToFormatDefaults()
```
    Resets the unit's format to the control default values
  - getThresholdCount
```
int getThresholdCount()
```
    Deprecated.
    use WebThresholds.size() via WebThresholdsContainer.getThresholds()
    
    Returns number of thresholds on the unit
    
    Returns:
    
    number of thresholds on the unit
  - getThreshold
```
RWThreshold getThreshold(int i)
```
    Deprecated.
    use WebThresholds.get(int) via WebThresholdsContainer.getThresholds()
    
    Returns i-th threshold
    
    Parameters:
    
    i - index
    
    Returns:
    
    RWThreshold i-th threshold
  - getThreshold
```
RWThreshold getThreshold(java.lang.String id)
```
    Deprecated.
    use WebThresholds.get(String) via WebThresholdsContainer.getThresholds()
    
    Returns threshold by its ID
    
    Parameters:
    
    id - threshold ID
    
    Returns:
    
    threshold
  - getFormat
```
WebFormat getFormat(java.lang.String id)
```
    Deprecated.
    use WebThreshold.getFormat() via WebThresholdsContainer.getThresholds() and WebThresholds.get(String)
    
    Returns format of the threshold with specified ID
    
    Parameters:
    
    id - threshold ID
    
    Returns:
    
    threshold format
  - getName
```
java.lang.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
    
    Specified by:
    
    getName in interface WebThresholdsContainer
    
    Returns:
    
    name
    
    Since:
    
    MicroStrategy Web 8.1.0
  - setName
```
void setName(java.lang.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
    
    Parameters:
    
    name -
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getFormatTypes
```
int[] getFormatTypes()
```
    Returns a list of format types applicable to the given object
    
    Returns:
    
    int[]
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getFormat
```
WebFormat getFormat(int formatType)
```
    Returns a format object for the given format type.
    
    Parameters:
    
    formatType - format type
    
    Returns:
    
    WebFormat
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getKeyContext
```
java.lang.String getKeyContext()
```
    Returns a unique id to be used by the backend to identify any unit.
    
    Returns:
    
    unique identifier
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getFilterDetailsFormatting
```
FilterDetailsFormatting getFilterDetailsFormatting()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - getTreeType
```
java.lang.String getTreeType()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - getElementControlGroupBys
```
RWControlGroupBys getElementControlGroupBys()
```
    Returns a RWControlGroupBys object, which is a collection of all element selection RWControlGroupBy objects
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getAllControlGroupBys
```
java.util.List getAllControlGroupBys()
```
    Returns a list of all the controlGroupBys RWControlGroupBy on this unit including element selector and metric selector targeting control groupBys
    
    Since:
    
    MicroStrategy Web 9.0.1
  - flushFormatChanges
```
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.
    
    Parameters:
    
    applyToAllViews -
  - getTheme
```
WebTheme getTheme()
```

Interface RWUnitDef

Method Summary

Methods inherited from interface com.microstrategy.web.objects.WebThresholdsContainer

Method Detail

getType

getKey

getRwDefinition

getParent

getFormat

copyFormat

isFirst

isLast

nextSibling

prevSibling

isVisible

setVisible

revertToFormatDefaults

getThresholdCount

getThreshold

getThreshold

getFormat

getName

setName

getFormatTypes

getFormat

getKeyContext

getFilterDetailsFormatting

getTreeType

getElementControlGroupBys

getAllControlGroupBys

flushFormatChanges

getTheme