com.microstrategy.web.objects.WebDisplayHelper |
The WebDisplayHelper interface is used to generate display XML containing both the contents
of an object (such as the current state of a filter or a prompt) and a list of available objects which
the user can choose from to add to the object. This interface is obtained from objects
which can be the selected section of a display XML, for example, WebFilter
object and WebPrompt
object.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract void |
applyDefaultDisplaySettings()
Modifies the content of Available Display Units collection based on the
current values of WebDefaultDisplaySettings.
| ||||||||||
abstract WebDisplayUnits |
getAvailableDisplayUnits()
This method returns the available display units collection, which is used to
modify the list of available objects which will be placed in the display XML.
| ||||||||||
abstract WebDefaultDisplaySettings |
getDefaultDisplaySettings()
This method returns the
WebDefaultDisplaySettings object, which
can be used to change the settings for default highlighting and selection. |
Modifies the content of Available Display Units collection based on the current values of WebDefaultDisplaySettings. This can be useful if a user wants to build a GUI directly from the WebDisplayUnits collection.
WebObjectsException | Thrown if ???. |
---|
This method returns the available display units collection, which is used to modify the list of available objects which will be placed in the display XML.
WebDisplayUnits
collection associated with this display
helper.
This method returns the WebDefaultDisplaySettings
object, which
can be used to change the settings for default highlighting and selection.
WebDefaultDisplaySettings
object associated with this display
helper instance.