Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

GridFormatEditorBean

implements GridFormatBean

com.microstrategy.web.app.beans.GridFormatEditorBean

Class Overview

This class provides the grid formatting editor interface for modifying the looks of the grid currently being displayed to the user.

Summary

Constants
int	BORDER_LEVEL_ALL	Border level that specifies the selected style and color of border will apply to all the edges of the target
int	BORDER_LEVEL_CUSTOM	Border level that specifies the selected style and color of border will be applied as given
int	BORDER_LEVEL_DEFAULT	Border level that specifies the target will use the default border properties
int	BORDER_LEVEL_NONE	Border level that specifies no border will be used for the requested target
int	NUMBER_CATEGORY_UNKNOWN	Number category to indicate nothing has been specified

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

From interface com.microstrategy.web.app.beans.AppComponent

Public Methods
abstract int	getCurrentTab() Get the tab that it's currently selected for being displayed by the Grid Format Editor.
abstract int	getNumberCategory() Get the format number category that is assigned to the object (if applicable)
abstract void	setBorderPicker(ShortcutList borderPicker)
abstract void	setCurrentTab(int currentTab) Set the tab to be displayed by the Grid Format Editor as current one.
abstract void	setDatePicker(ShortcutList datePicker)
abstract void	setFillColorPicker(ShortcutList fillColorPicker)
abstract void	setFontColorPicker(ShortcutList fontColorPicker)
abstract void	setFontPicker(ShortcutList fontPicker)
abstract void	setFractionPicker(ShortcutList fractionPicker)
abstract void	setNumberCategory(int category) Set the format number category that is assigned to the object
abstract void	setSizePicker(ShortcutList sizePicker)
abstract void	setTimePicker(ShortcutList timePicker)

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.app.beans.AppComponent

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.FrameElement

abstract FrameBean	getFrameBean() Returns the frame bean that is containing this FrameElement.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
abstract boolean	isEditor() Indicates whether a ReportFrameElement most be considered editor.
abstract boolean	isEnabled() Indicates whether a ReportFrameElement is Enabled.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output

From interface com.microstrategy.web.app.beans.GridFormatBean

From interface com.microstrategy.web.app.beans.ReportFrameElement

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Constants

public static final int BORDER_LEVEL_ALL

Border level that specifies the selected style and color of border will apply to all the edges of the target

Constant Value: 1 (0x00000001)

public static final int BORDER_LEVEL_CUSTOM

Border level that specifies the selected style and color of border will be applied as given

Constant Value: 2 (0x00000002)

public static final int BORDER_LEVEL_DEFAULT

Border level that specifies the target will use the default border properties

Constant Value: 3 (0x00000003)

public static final int BORDER_LEVEL_NONE

Border level that specifies no border will be used for the requested target

Constant Value: 0 (0x00000000)

public static final int NUMBER_CATEGORY_UNKNOWN

Number category to indicate nothing has been specified

Constant Value: -9999 (0xffffd8f1)

Public Methods

public abstract int getCurrentTab ()

Get the tab that it's currently selected for being displayed by the Grid Format Editor.

Returns

int value element from the EnumGridFormatEditorTabs enumeration representing the current tab.

public abstract int getNumberCategory ()

Get the format number category that is assigned to the object (if applicable)

Returns

a value from the EnumGridFormatNumberCategory corresponding to the number category property

public abstract void setBorderPicker (ShortcutList borderPicker)

Parameters

borderPicker	The borderPicker to set.

public abstract void setCurrentTab (int currentTab)

Set the tab to be displayed by the Grid Format Editor as current one.

Parameters

currentTab	`int` value element from the `EnumGridFormatEditorTabs` enumeration

public abstract void setDatePicker (ShortcutList datePicker)

Parameters

datePicker	The datePicker to set.

public abstract void setFillColorPicker (ShortcutList fillColorPicker)

Parameters

fillColorPicker	The fillColorPicker to set.

public abstract void setFontColorPicker (ShortcutList fontColorPicker)

Parameters

fontColorPicker	The fontColorPicker to set.

public abstract void setFontPicker (ShortcutList fontPicker)

Parameters

fontPicker	The fontPicker to set.

public abstract void setFractionPicker (ShortcutList fractionPicker)

Parameters

fractionPicker	The fractionPicker to set.

public abstract void setNumberCategory (int category)

Set the format number category that is assigned to the object

Parameters

category	a value of the `EnumGridFormatNumberCategory` enumeration corresponding to the category

public abstract void setSizePicker (ShortcutList sizePicker)

Parameters

sizePicker	The sizePicker to set.

public abstract void setTimePicker (ShortcutList timePicker)

Parameters

timePicker	The timePicker to set.

Interfaces

Classes

Exceptions

GridFormatEditorBean

Class Overview

Summary

Constants

public static final int BORDER_LEVEL_ALL

public static final int BORDER_LEVEL_CUSTOM

public static final int BORDER_LEVEL_DEFAULT

public static final int BORDER_LEVEL_NONE

public static final int NUMBER_CATEGORY_UNKNOWN

Public Methods

public abstract int getCurrentTab ()

Returns

public abstract int getNumberCategory ()

Returns

public abstract void setBorderPicker (ShortcutList borderPicker)

Parameters

public abstract void setCurrentTab (int currentTab)

Parameters

public abstract void setDatePicker (ShortcutList datePicker)

Parameters

public abstract void setFillColorPicker (ShortcutList fillColorPicker)

Parameters

public abstract void setFontColorPicker (ShortcutList fontColorPicker)

Parameters

public abstract void setFontPicker (ShortcutList fontPicker)

Parameters

public abstract void setFractionPicker (ShortcutList fractionPicker)

Parameters

public abstract void setNumberCategory (int category)

Parameters

public abstract void setSizePicker (ShortcutList sizePicker)

Parameters

public abstract void setTimePicker (ShortcutList timePicker)

Parameters