Package com.microstrategy.web.app.gui
Class AbstractGuiElement
- java.lang.Object
-
- com.microstrategy.web.app.gui.AbstractGuiElement
-
- All Implemented Interfaces:
GuiElement
- Direct Known Subclasses:
AbstractShortcut
,AbstractShortcutList
,CartImpl
,EditorImpl
,GGCalendarImpl
,IncrementalFetchImpl
,MenuImpl
,QuickLinksImpl
,ScrollerImpl
,SubscriptionFileWidgetImpl
,SubscriptionFileWidgetImpl
,TreeBoxImpl
,TreeViewImpl
public abstract class AbstractGuiElement extends java.lang.Object implements GuiElement
Title: AbstractGuiElement.
Description: abstract implementation of GuiElement
Copyright: Copyright (c) 2002
Company: Microstrategy, Inc.
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
Fields Modifier and Type Field Description protected AppContext
_appContext
theAppContext
object associated with this gui elementprotected java.lang.String
_name
name of the gui elementprotected WebComponent
_webComponent
theWebComponent
object associated with this gui element
-
Constructor Summary
Constructors Constructor Description AbstractGuiElement()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description AppContext
getAppContext()
return theAppContext
object associated with this gui elementjava.lang.String
getDescriptor(int key)
get descriptor by a keyjava.lang.String
getDescriptor(int key, java.lang.String defaultValue)
java.lang.String
getDescriptor(java.lang.String key)
get descriptor by a keyEventManager
getEventManager()
get event manager for this gui elementjava.lang.String
getExtraInput()
get extra input information for this gui elementjava.lang.String
getExtraUrl()
get extra url information for this gui elementWebFeatures
getFeatures()
Get theWebFeatures
object associated with this gui elementMessages
getMessages()
get theMessages
object associated with this gui elementjava.lang.String
getName()
get the name of the gui elementprotected TagsFactory
getTagsFactory()
boolean
getUseIFrame()
Indicates whether the instance uses IFrames in its outputWebComponent
getWebComponent()
get theWebComponent
object associated with this gui elementboolean
isDhtml()
Returns true if the output mode has been set to dhtmlboolean
isIFrameEnabled()
return whether the gui element is iframe enabledprotected ParameterBuilder
newHiddenInputBuilder()
Convenience method to retrieve a new Hidden Input Builder object from the stored AppContext.protected NamespaceEncoder
newNamespaceEncoder()
Convenience method to retrieve a new Namespace Encoder object from the stored AppContext.protected ParameterBuilder
newURIBuilder()
Convenience method to retrieve a new URI Builder object from the stored AppContext.abstract MarkupOutput
renderElement()
render the gui element in a MarkupOutput objectboolean
renderElement(MarkupOutput mo)
Render the current GUI Element with the information providedvoid
setAppContext(AppContext value)
set theAppContext
object associated with this gui elementvoid
setExtraInput(java.lang.String newValue)
set extra url information for this gui elementvoid
setExtraUrl(java.lang.String newValue)
set extra url information for this gui elementvoid
setName(java.lang.String value)
set the name of the gui elementvoid
setUseIFrame(boolean value)
Sets whether a ReportFrameElement should use IFrames in its outputvoid
setWebComponent(WebComponent value)
set theWebComponent
object associated with this gui element
-
-
-
Field Detail
-
_name
protected java.lang.String _name
name of the gui element
-
_appContext
protected AppContext _appContext
theAppContext
object associated with this gui element
-
_webComponent
protected WebComponent _webComponent
theWebComponent
object associated with this gui element
-
-
Method Detail
-
renderElement
public abstract MarkupOutput renderElement()
render the gui element in a MarkupOutput object- Specified by:
renderElement
in interfaceGuiElement
- Returns:
- the
MarkupOutput
object
-
renderElement
public boolean renderElement(MarkupOutput mo)
Render the current GUI Element with the information provided- Specified by:
renderElement
in interfaceGuiElement
- 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
-
getFeatures
public WebFeatures getFeatures()
Get theWebFeatures
object associated with this gui element- Specified by:
getFeatures
in interfaceGuiElement
- Returns:
- the
WebFeatures
object
-
getMessages
public Messages getMessages()
get theMessages
object associated with this gui element- Specified by:
getMessages
in interfaceGuiElement
- Returns:
- the
Messages
object
-
getDescriptor
public java.lang.String getDescriptor(int key)
get descriptor by a key- Specified by:
getDescriptor
in interfaceGuiElement
- Parameters:
key
- the key for the descriptor- Returns:
- the descriptor
-
getDescriptor
public java.lang.String getDescriptor(int key, java.lang.String defaultValue)
-
getDescriptor
public java.lang.String getDescriptor(java.lang.String key)
get descriptor by a key- Specified by:
getDescriptor
in interfaceGuiElement
- Parameters:
key
- the key for the descriptor- Returns:
- the descriptor
-
setName
public void setName(java.lang.String value)
set the name of the gui element- Specified by:
setName
in interfaceGuiElement
- Parameters:
value
- the name
-
getName
public java.lang.String getName()
get the name of the gui element- Specified by:
getName
in interfaceGuiElement
- Returns:
- the name
-
setAppContext
public void setAppContext(AppContext value)
set theAppContext
object associated with this gui element- Specified by:
setAppContext
in interfaceGuiElement
- Parameters:
value
- theAppContext
object
-
getAppContext
public AppContext getAppContext()
return theAppContext
object associated with this gui element- Specified by:
getAppContext
in interfaceGuiElement
- Returns:
- the
AppContext
object
-
setWebComponent
public void setWebComponent(WebComponent value)
set theWebComponent
object associated with this gui element- Specified by:
setWebComponent
in interfaceGuiElement
- Parameters:
value
- theWebComponent
object
-
getWebComponent
public WebComponent getWebComponent()
get theWebComponent
object associated with this gui element- Specified by:
getWebComponent
in interfaceGuiElement
- Returns:
- the
WebComponent
object
-
isIFrameEnabled
public boolean isIFrameEnabled()
return whether the gui element is iframe enabled- Returns:
- whether the gui element is iframe enabled
-
setUseIFrame
public void setUseIFrame(boolean value)
Sets whether a ReportFrameElement should use IFrames in its output- Specified by:
setUseIFrame
in interfaceGuiElement
- Parameters:
value
- true if IFrrames are enabled
-
getUseIFrame
public boolean getUseIFrame()
Indicates whether the instance uses IFrames in its output- Specified by:
getUseIFrame
in interfaceGuiElement
- Returns:
- true if it uses IFrames
-
getEventManager
public EventManager getEventManager()
get event manager for this gui element- Specified by:
getEventManager
in interfaceGuiElement
- Returns:
- the
EventManager
object
-
setExtraUrl
public void setExtraUrl(java.lang.String newValue)
set extra url information for this gui element- Specified by:
setExtraUrl
in interfaceGuiElement
- Parameters:
newValue
- the extra url info
-
getExtraUrl
public java.lang.String getExtraUrl()
get extra url information for this gui element- Specified by:
getExtraUrl
in interfaceGuiElement
- Returns:
- the extra url
-
setExtraInput
public void setExtraInput(java.lang.String newValue)
set extra url information for this gui element- Specified by:
setExtraInput
in interfaceGuiElement
- Parameters:
newValue
- the extra input
-
getExtraInput
public java.lang.String getExtraInput()
get extra input information for this gui element- Specified by:
getExtraInput
in interfaceGuiElement
- Returns:
- the extra input
-
isDhtml
public boolean isDhtml()
Returns true if the output mode has been set to dhtml- Returns:
boolean
value ofTrue
if the output of this element is DHTML; returnsFalse
otherwise.- Since:
- MicroStrategy Web 8.0.0
-
newURIBuilder
protected ParameterBuilder newURIBuilder()
Convenience method to retrieve a new URI Builder object from the stored AppContext.- Returns:
- A new instance of a
ParameterBuilder
object that constructs URIs. - Since:
- MicroStrategy Web 8.0.0
-
newHiddenInputBuilder
protected ParameterBuilder newHiddenInputBuilder()
Convenience method to retrieve a new Hidden Input Builder object from the stored AppContext.- Returns:
- A new instance of a
ParameterBuilder
object that constructs hidden inputs. - Since:
- MicroStrategy Web 8.0.0
-
newNamespaceEncoder
protected NamespaceEncoder newNamespaceEncoder()
Convenience method to retrieve a new Namespace Encoder object from the stored AppContext.- Returns:
- A new instance of a
NamespaceEncoder
object that encode names. - Since:
- MicroStrategy Web 8.0.0
-
getTagsFactory
protected TagsFactory getTagsFactory()
- Returns:
TagsFactory
initialized instance- Since:
- MicroStrategy Web 8.0.0
-
-