Package com.microstrategy.web.objects
Interface WebDisplayHelper
- 
public interface WebDisplayHelperThe 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,WebFilterobject andWebPromptobject.- Since:
 - MicroStrategy Web 7.3.1 or earlier
 
 
- 
- 
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidapplyDefaultDisplaySettings()Modifies the content of Available Display Units collection based on the current values of WebDefaultDisplaySettings.WebDisplayUnitsgetAvailableDisplayUnits()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.WebDefaultDisplaySettingsgetDefaultDisplaySettings()This method returns theWebDefaultDisplaySettingsobject, which can be used to change the settings for default highlighting and selection. 
 - 
 
- 
- 
Method Detail
- 
getDefaultDisplaySettings
WebDefaultDisplaySettings getDefaultDisplaySettings()
This method returns theWebDefaultDisplaySettingsobject, which can be used to change the settings for default highlighting and selection.- Returns:
 - The 
WebDefaultDisplaySettingsobject associated with this display helper instance. 
 
- 
getAvailableDisplayUnits
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.- Returns:
 - The 
WebDisplayUnitscollection associated with this display helper. 
 
- 
applyDefaultDisplaySettings
void applyDefaultDisplaySettings() throws WebObjectsExceptionModifies 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.- Throws:
 WebObjectsException- Thrown if ???.
 
 - 
 
 -