public interface

WebDisplayHelper

com.microstrategy.web.objects.WebDisplayHelper

Class Overview

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.

Summary

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.

Public Methods

public abstract void applyDefaultDisplaySettings ()

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.

Throws
WebObjectsException Thrown if ???.

public 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.

Returns

public abstract WebDefaultDisplaySettings getDefaultDisplaySettings ()

This method returns the WebDefaultDisplaySettings object, which can be used to change the settings for default highlighting and selection.

Returns