Package com.microstrategy.web.app.gui

Interface GuiElement

All Known Subinterfaces:

Cart, CartElementPicker, CartExpression, CartFontStyles, CartObjectBrowser, ContactsCart, DefaultSubscriptionWidget, com.microstrategy.web.app.transforms.DefaultSubscriptionWidget, Editor, GGCalendar, GuiComponent, IncrementalFetch, Menu, ObjectInfoWidget, QuickLinks, ScheduleWidget, Scroller, SendNowWidget, ShortcutElement, ShortcutListElement, SubscriptionFileWidget, SubscriptionFileWidget, SubscriptionPrintWidget, SubscriptionWidget, com.microstrategy.web.app.transforms.SubscriptionWidget, Toolbar, TreeBox, TreeCart, TreeCartExpression, TreeView

All Known Implementing Classes:

AbstractGuiElement, AbstractShortcut, AbstractShortcutList, AlertsSubscriptionMobileWidgetImpl, CartAttFormsImpl, CartDualAxisDistribution, CartElementPickerImpl, CartExpressionImpl, CartFontStylesImpl, CartImpl, CartObjectBrowserImpl, DivBasedCartImpl, EditorImpl, GGCalendarImpl, IncrementalFetchImpl, MenuImpl, QuickLinksImpl, ScrollerImpl, ShortcutAnchor, ShortcutBean, ShortcutButton, ShortcutButtonLabel, ShortcutCaption, ShortcutColorPickerPane, ShortcutCombo, ShortcutDefault, ShortcutGridInfo, ShortcutGridLevels, ShortcutInput, ShortcutLabel, ShortcutListPicker, ShortcutListPickerElement, ShortcutListStyles, ShortcutPickerOption, ShortcutPulldown, ShortcutTextcombo, SubscriptionCacheWidgetImpl, SubscriptionFileWidgetImpl, SubscriptionFileWidgetImpl, SubscriptionHistoryListWidgetImpl, SubscriptionMobileWidgetImpl, SubscriptionPersonalViewTransform.SubscriptionPersonalViewWidgetImpl, SubscriptionPrintWidgetImpl, TreeBoxImpl, TreeCartExpressionImpl, TreeCartImpl, TreeViewImpl, UserEntitiesTreeCartImpl

public interface GuiElement

Title: GuiElement.

Description: Root interface for any GUI Element in MicroStategy Web. GUI Elements represent independent objects that display information to the user. These objects are generally interactive and are utilize by transforms to enrich the user's experience when information is display and/or requested from the user. GUI Elements are created through the GUIElementFactory class. Among the objects available you can find:

• Tree Control
• Toolbar
• Subscription Widgets
• Calendar
• Context Menu
• Cart
• Editor

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
AppContext	getAppContext()	Get the AppContext instance used by this element
java.lang.String	getDescriptor(int key)	Get the descriptor associated with the numeric key given
java.lang.String	getDescriptor(java.lang.String key)	Get the descriptor associated with the string key given
EventManager	getEventManager()	get the EventManager object associated with this gui element
java.lang.String	getExtraInput()	get extra input info for the gui element
java.lang.String	getExtraUrl()	get extra url info for the gui element
WebFeatures	getFeatures()	Get the WebFeatures instance used by this element
Messages	getMessages()	Get the Messages instance used by this element
java.lang.String	getName()	Get the name property of this GUI element
boolean	getUseIFrame()	Indicates whether a ReportFrameElement uses IFrames in its output
WebComponent	getWebComponent()	Get the WebComponent instance used by this element
MarkupOutput	renderElement()	Render the GUI Element represented by this instance
boolean	renderElement(MarkupOutput out)
void	setAppContext(AppContext value)	Set the AppContext instance to be used by this element
void	setExtraInput(java.lang.String newValue)	set extra input info for the gui element
void	setExtraUrl(java.lang.String newValue)	set extra url info for the gui element
void	setName(java.lang.String editorName)	Set the name property of this GUI element
void	setUseIFrame(boolean value)	Sets whether a ReportFrameElement should use IFrames in its output
void	setWebComponent(WebComponent value)	Set the WebComponent instance to be used by this element

Method Detail

renderElement

MarkupOutput renderElement()

Render the GUI Element represented by this instance

Returns:

a MarkupOutput instance initialized with the HTML code to render for this element

renderElement

boolean renderElement(MarkupOutput out)

getFeatures

WebFeatures getFeatures()

Get the WebFeatures instance used by this element

Returns:

the WebFeatures instance assigned to this element

getMessages

Messages getMessages()

Get the Messages instance used by this element

Returns:

the Messages instance assigned to this element

setName

void setName(java.lang.String editorName)

Set the name property of this GUI element

Parameters:

editorName - String with the name to associate to this element

getName

java.lang.String getName()

Get the name property of this GUI element

Returns:

a String with the name associated to this element

setAppContext

void setAppContext(AppContext value)

Set the AppContext instance to be used by this element

Parameters:

value - the AppContext instance to assign to this element

getAppContext

AppContext getAppContext()

Get the AppContext instance used by this element

Returns:

the AppContext instance assigned to this element

setWebComponent

void setWebComponent(WebComponent value)

Set the WebComponent instance to be used by this element

Parameters:

value - the WebComponent instance to assign to this element

getWebComponent

WebComponent getWebComponent()

Get the WebComponent instance used by this element

Returns:

the WebComponent instance assigned to this element

getDescriptor

java.lang.String getDescriptor(int key)

Get the descriptor associated with the numeric key given

Parameters:

key - an int representing the key to search for

Returns:

the String descriptor found related with the given key

getDescriptor

java.lang.String getDescriptor(java.lang.String key)

Get the descriptor associated with the string key given

Parameters:

key - a String representing the key to search for

Returns:

the String descriptor found related with the given key

setUseIFrame

void setUseIFrame(boolean value)

Sets whether a ReportFrameElement should use IFrames in its output

Parameters:

value - true if IFrrames are enabled

getUseIFrame

boolean getUseIFrame()

Indicates whether a ReportFrameElement uses IFrames in its output

Returns:

true if it uses IFrames

getEventManager

EventManager getEventManager()

get the EventManager object associated with this gui element

Returns:

the EventManager object

setExtraUrl

void setExtraUrl(java.lang.String newValue)

set extra url info for the gui element

Parameters:

newValue - the extra url info

getExtraUrl

java.lang.String getExtraUrl()

get extra url info for the gui element

Returns:

the extra url info

setExtraInput

void setExtraInput(java.lang.String newValue)

set extra input info for the gui element

Parameters:

newValue - extra input info

getExtraInput

java.lang.String getExtraInput()

get extra input info for the gui element

Returns:

extra input info