WebDisplayUnit
implements KeyedObject| com.microstrategy.web.objects.WebDisplayUnit |
 Known Indirect Subclasses
|
Class Overview
The WebDisplayUnit interface represents an object which can have display XML generated for it.
There are several states which a display unit can be in:
- highlighted - If an object is highlighted, then it will have an attribute highlight set to 1 in the generated display XML.
- selected - If an object is selected, then it will have an attribute selected set to 1 in the generated display XML.
- has details(detailed) - If an object has details, then it will have more information about it in the display XML. For a dimension, this will retrieve it's attributes; for a folder, the objects it contains; for an attribute, its forms and elements.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
addDetails(boolean details)
This method will add or remove details from the display unit.
| ||||||||||
| abstract void | applyVisitor(DisplayUnitsVisitor visitor, boolean deep) | ||||||||||
| abstract boolean | canHighlight() | ||||||||||
| abstract WebDisplayUnits |
getChildUnits()
Returns the collection of child display units, or null if the object is
not a collection.
| ||||||||||
| abstract String |
getDisplayName()
Returns the display name associated with this object.
| ||||||||||
| abstract int |
getDisplayUnitType()
Returns the type of display unit that this object represents.
| ||||||||||
| abstract String |
getID()
Returns the DSS ID of the display unit.
| ||||||||||
| abstract boolean |
hasDetails()
Returns whether this display unit currently has details enabled.
| ||||||||||
| abstract void |
highlightUnit()
Sets this display unit to be highlighted.
| ||||||||||
| abstract void |
highlightUnit(boolean details)
Sets this display unit to be highlighted.
| ||||||||||
| abstract boolean |
isHighlighted()
Returns whether this unit is highlighted.
| ||||||||||
| abstract boolean |
isObjectInfo()
Returns true if underlying Web Object can be cast to
WebObjectInfo. | ||||||||||
| abstract boolean |
isSelected()
Returns whether this display unit is selected.
| ||||||||||
| abstract void |
setDisplayName(String displayName)
This method will set the value of the display name.
| ||||||||||
| abstract void |
setSelected(boolean selected)
Sets the current unit's selection status.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.KeyedObject
| |||||||||||
Public Methods
public abstract void addDetails (boolean details)
This method will add or remove details from the display unit. Note that this call may generate a call to the Intelligence Server if the details are not already present for the display unit.
Parameters
| details | The desired state of details for the display unit. |
|---|
Throws
| WebObjectsException | Thrown if the details cannot be retrieved from the Intelligence Server. |
|---|
public abstract void applyVisitor (DisplayUnitsVisitor visitor, boolean deep)
Throws
| WebObjectsException |
|---|
public abstract boolean canHighlight ()
public abstract WebDisplayUnits getChildUnits ()
Returns the collection of child display units, or null if the object is not a collection. Note that several display units are actually collections of display units as well.
Returns
- The collection of child display units of this instance, or null if this object is not a collection.
Throws
| WebObjectsException |
|---|
public abstract String getDisplayName ()
Returns the display name associated with this object. If this was not set by the user or found in the object XML, then this will be equivalent to the name property of the underlying object.
Returns
- The display name associated with the display unit object.
See Also
public abstract int getDisplayUnitType ()
Returns the type of display unit that this object represents. If this
display unit represents a first-class object, then this method will
return a value from EnumDSSXMLObjectTypes; otherwise, it will
return a value from EnumWebDependentObjectType.
Returns
- The display unit type, from
EnumDSSXMLObjectTypesorEnumWebDependentObjectType.
public abstract String getID ()
Returns the DSS ID of the display unit.
Returns
- The ID of the display unit.
public abstract boolean hasDetails ()
Returns whether this display unit currently has details enabled.
Returns
- True if details are enabled, false otherwise.
public abstract void highlightUnit ()
Sets this display unit to be highlighted. This call will ensure that details are not present for the highlighted unit.
public abstract void highlightUnit (boolean details)
Sets this display unit to be highlighted. The details value will determine whether it should include details as well.
Parameters
| details | Whether the highlighted unit should include details. |
|---|
Throws
| WebObjectsException | Thrown if the details for a highlighted unit cannot be retrieved from the Intelligence Server. |
|---|
public abstract boolean isHighlighted ()
Returns whether this unit is highlighted.
Returns
- True if the display unit is highlighted, false otherwise.
public abstract boolean isObjectInfo ()
Returns true if underlying Web Object can be cast to WebObjectInfo. If
an object can be cast to WebObjectInfo, then it is a first class object.
Returns
- true if underlying Web Object can be cast to
WebObjectInfo.
public abstract boolean isSelected ()
Returns whether this display unit is selected.
Returns
- True if the unit is selected, false otherwise.
public abstract void setDisplayName (String displayName)
This method will set the value of the display name. This name will be used to identify the object in display XML. Setting this value will have no affect on the actual name of the object.
Parameters
| displayName | The display name to associate with the object. |
|---|
See Also
public abstract void setSelected (boolean selected)
Sets the current unit's selection status.
Parameters
| selected | Whether the unit should be set to be selected or not. |
|---|