public abstract class

AbstractGuiElement

extends Object
implements GuiElement
java.lang.Object
   ↳ com.microstrategy.web.app.gui.AbstractGuiElement
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Title: AbstractGuiElement.

Description: abstract implementation of GuiElement

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Summary

Fields
protected AppContext _appContext the AppContext object associated with this gui element
protected String _name name of the gui element
protected WebComponent _webComponent the WebComponent object associated with this gui element
Public Constructors
AbstractGuiElement()
Public Methods
AppContext getAppContext()
return the AppContext object associated with this gui element
String getDescriptor(int key)
get descriptor by a key
String getDescriptor(String key)
get descriptor by a key
EventManager getEventManager()
get event manager for this gui element
String getExtraInput()
get extra input information for this gui element
String getExtraUrl()
get extra url information for this gui element
WebFeatures getFeatures()
Get the WebFeatures object associated with this gui element
Messages getMessages()
get the Messages object associated with this gui element
String getName()
get the name of the gui element
boolean getUseIFrame()
Indicates whether the instance uses IFrames in its output
WebComponent getWebComponent()
get the WebComponent object associated with this gui element
boolean isDhtml()
Returns true if the output mode has been set to dhtml
boolean isIFrameEnabled()
return whether the gui element is iframe enabled
boolean renderElement(MarkupOutput mo)
Render the current GUI Element with the information provided
abstract MarkupOutput renderElement()
render the gui element in a MarkupOutput object
void setAppContext(AppContext value)
set the AppContext object associated with this gui element
void setExtraInput(String newValue)
set extra url information for this gui element
void setExtraUrl(String newValue)
set extra url information for this gui element
void setName(String value)
set the name of the gui element
void setUseIFrame(boolean value)
Sets whether a ReportFrameElement should use IFrames in its output
void setWebComponent(WebComponent value)
set the WebComponent object associated with this gui element
Protected Methods
TagsFactory getTagsFactory()
ParameterBuilder newHiddenInputBuilder()
Convenience method to retrieve a new Hidden Input Builder object from the stored AppContext.
NamespaceEncoder newNamespaceEncoder()
Convenience method to retrieve a new Namespace Encoder object from the stored AppContext.
ParameterBuilder newURIBuilder()
Convenience method to retrieve a new URI Builder object from the stored AppContext.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.app.gui.GuiElement

Fields

protected AppContext _appContext

the AppContext object associated with this gui element

protected String _name

name of the gui element

protected WebComponent _webComponent

the WebComponent object associated with this gui element

Public Constructors

public AbstractGuiElement ()

Public Methods

public AppContext getAppContext ()

return the AppContext object associated with this gui element

Returns

public String getDescriptor (int key)

get descriptor by a key

Parameters
key the key for the descriptor
Returns
  • the descriptor

public String getDescriptor (String key)

get descriptor by a key

Parameters
key the key for the descriptor
Returns
  • the descriptor

public EventManager getEventManager ()

get event manager for this gui element

Returns

public String getExtraInput ()

get extra input information for this gui element

Returns
  • the extra input

public String getExtraUrl ()

get extra url information for this gui element

Returns
  • the extra url

public WebFeatures getFeatures ()

Get the WebFeatures object associated with this gui element

Returns

public Messages getMessages ()

get the Messages object associated with this gui element

Returns

public String getName ()

get the name of the gui element

Returns
  • the name

public boolean getUseIFrame ()

Indicates whether the instance uses IFrames in its output

Returns
  • true if it uses IFrames

public WebComponent getWebComponent ()

get the WebComponent object associated with this gui element

Returns

public boolean isDhtml ()

Returns true if the output mode has been set to dhtml

Returns
  • boolean value of True if the output of this element is DHTML; returns False otherwise.

public boolean isIFrameEnabled ()

return whether the gui element is iframe enabled

Returns
  • whether the gui element is iframe enabled

public boolean renderElement (MarkupOutput mo)

Render the current GUI Element with the information provided

Parameters
mo MarkupOutput instance where the HTML information to display to the user is to be saved.
Returns
  • boolean value indicating if the render operation was successful or not

public abstract MarkupOutput renderElement ()

render the gui element in a MarkupOutput object

Returns

public void setAppContext (AppContext value)

set the AppContext object associated with this gui element

Parameters
value the AppContext object

public void setExtraInput (String newValue)

set extra url information for this gui element

Parameters
newValue the extra input

public void setExtraUrl (String newValue)

set extra url information for this gui element

Parameters
newValue the extra url info

public void setName (String value)

set the name of the gui element

Parameters
value the name

public void setUseIFrame (boolean value)

Sets whether a ReportFrameElement should use IFrames in its output

Parameters
value true if IFrrames are enabled

public void setWebComponent (WebComponent value)

set the WebComponent object associated with this gui element

Parameters
value the WebComponent object

Protected Methods

protected TagsFactory getTagsFactory ()

Returns

protected ParameterBuilder newHiddenInputBuilder ()

Convenience method to retrieve a new Hidden Input Builder object from the stored AppContext.

Returns

protected NamespaceEncoder newNamespaceEncoder ()

Convenience method to retrieve a new Namespace Encoder object from the stored AppContext.

Returns

protected ParameterBuilder newURIBuilder ()

Convenience method to retrieve a new URI Builder object from the stored AppContext.

Returns