public interface

GuiElement

com.microstrategy.web.app.gui.GuiElement
Known Indirect Subclasses

Class Overview

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.

Summary

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

Public Methods

public abstract AppContext getAppContext ()

Get the AppContext instance used by this element

Returns

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

public abstract String getDescriptor (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

public abstract EventManager getEventManager ()

get the EventManager object associated with this gui element

Returns

public abstract String getExtraInput ()

get extra input info for the gui element

Returns
  • extra input info

public abstract String getExtraUrl ()

get extra url info for the gui element

Returns
  • the extra url info

public abstract WebFeatures getFeatures ()

Get the WebFeatures instance used by this element

Returns

public abstract Messages getMessages ()

Get the Messages instance used by this element

Returns
  • the Messages instance assigned to this element

public abstract String getName ()

Get the name property of this GUI element

Returns
  • a String with the name associated to this element

public abstract boolean getUseIFrame ()

Indicates whether a ReportFrameElement uses IFrames in its output

Returns
  • true if it uses IFrames

public abstract WebComponent getWebComponent ()

Get the WebComponent instance used by this element

Returns

public abstract boolean renderElement (MarkupOutput out)

public abstract MarkupOutput renderElement ()

Render the GUI Element represented by this instance

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

public abstract void setAppContext (AppContext value)

Set the AppContext instance to be used by this element

Parameters
value the AppContext instance to assign to this element

public abstract void setExtraInput (String newValue)

set extra input info for the gui element

Parameters
newValue extra input info

public abstract void setExtraUrl (String newValue)

set extra url info for the gui element

Parameters
newValue the extra url info

public abstract void setName (String editorName)

Set the name property of this GUI element

Parameters
editorName String with the name to associate to this element

public abstract void setUseIFrame (boolean value)

Sets whether a ReportFrameElement should use IFrames in its output

Parameters
value true if IFrrames are enabled

public abstract void setWebComponent (WebComponent value)

Set the WebComponent instance to be used by this element

Parameters
value the WebComponent instance to assign to this element