public interface

GuiComponent

implements GuiElement
com.microstrategy.web.app.gui.GuiComponent

Class Overview

Title: GuiComponent.

Description: interface for gui component. Each gui component represents a gui unit like grid, report editor, object browser.

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Summary

Public Methods
abstract boolean IsContainer()
get whether the gui component serves as a container for other gui components
abstract boolean IsIframeRequest()
This method is deprecated. No replacement.
abstract String getDisplayMode()
get the display mode used when the GuiComponent renders itself
abstract WebGuiComponent getGuiComponentInfo()
get the WebGuiComponent info for this gui component.
abstract boolean getIsIframeRequest()
get whether the current request is an iframe request
abstract Preferences getPreferences()
get the Preferences object for this gui component
abstract RequestKeys getRequestKeys()
get the RequestKeys object for this gui component
abstract WebComponent getRootWebComponent()
get the root WebComponent for this gui component
abstract boolean isAppendNewLine()
Return whether the GUI component is configured to render a new line character at the end of the output.
abstract boolean renderBlock()
the boolean indicates whether this GuiComponent allows sub json blocks to update or just pure HTML
abstract void setAppendNewLine(boolean appendNewLine)
Set whether the GUIComponent should render a new line character at the end of the output.
abstract void setDisplayMode(String newValue)
set the display mode used when the GuiComponent renders itself
abstract void setFormalParameter(String name, Object value)
Set the formal parameter on the GUI component.
abstract void setGuiComponentInfo(WebGuiComponent newValue)
set the WebGuiComponent info for this gui component.
abstract void setIsContainer(boolean newValue)
set whether the gui component serves as a container for other gui components
abstract void setIsIframeRequest(boolean newValue)
set whether the current request is an iframe request
abstract void setPreferences(Preferences newValue)
set the Preferences object for this gui component
abstract void setRenderBlock(boolean value)
set the flag to signal whether this GuiComponent allows sub json blocks to render so that partial update happens within the original GuiComponent
abstract void setRequestKeys(RequestKeys newValue)
set the Request Keys object for this gui component
abstract void setRootWebComponent(WebComponent newValue)
set the root WebComponent for this gui component
abstract void setStyle(String newValue)
set the style name for the gui component.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.gui.GuiElement

Public Methods

public abstract boolean IsContainer ()

get whether the gui component serves as a container for other gui components

Returns
  • whether the gui component serves as a container for other gui components

public abstract boolean IsIframeRequest ()

This method is deprecated.
No replacement.

get whether the current request is an iframe request

Returns
  • whether the current request is an iframe request

public abstract String getDisplayMode ()

get the display mode used when the GuiComponent renders itself

public abstract WebGuiComponent getGuiComponentInfo ()

get the WebGuiComponent info for this gui component.

Returns
  • the associated WebGuiComponent object

public abstract boolean getIsIframeRequest ()

get whether the current request is an iframe request

Returns
  • whether the current request is an iframe request

public abstract Preferences getPreferences ()

get the Preferences object for this gui component

Returns
  • the Preferences object

public abstract RequestKeys getRequestKeys ()

get the RequestKeys object for this gui component

Returns
  • the RequestKeys object

public abstract WebComponent getRootWebComponent ()

get the root WebComponent for this gui component

Returns
  • the root WebComponent object

public abstract boolean isAppendNewLine ()

Return whether the GUI component is configured to render a new line character at the end of the output.

public abstract boolean renderBlock ()

the boolean indicates whether this GuiComponent allows sub json blocks to update or just pure HTML

Returns
  • the boolean flag

public abstract void setAppendNewLine (boolean appendNewLine)

Set whether the GUIComponent should render a new line character at the end of the output. By default this is set to true. You can use this method to disable rendering a new line.

public abstract void setDisplayMode (String newValue)

set the display mode used when the GuiComponent renders itself

Parameters
newValue String the display mode: DISPLAY_MODE_HTML - plain HTML DISPLAY_MODE_JSON - the output will be wrapped up in a json structure in form of {id: id of the component, content: html content to be updated} or {id: if of the component, components: sub json blocks}

public abstract void setFormalParameter (String name, Object value)

Set the formal parameter on the GUI component. These will be set on the transform which the GUI component is rendering.

Parameters
name The name of the formal paramter whose value we want to set
value The value of the formal parameter

public abstract void setGuiComponentInfo (WebGuiComponent newValue)

set the WebGuiComponent info for this gui component. WebGuiComponent is one of the application configuration element

Parameters
newValue WebGuiComponent object

public abstract void setIsContainer (boolean newValue)

set whether the gui component serves as a container for other gui components

Parameters
newValue whether the gui component serves as a container for other gui components

public abstract void setIsIframeRequest (boolean newValue)

set whether the current request is an iframe request

Parameters
newValue whether the current request is an iframe request

public abstract void setPreferences (Preferences newValue)

set the Preferences object for this gui component

Parameters
newValue the Preferences object

public abstract void setRenderBlock (boolean value)

set the flag to signal whether this GuiComponent allows sub json blocks to render so that partial update happens within the original GuiComponent

Parameters
value boolean true if it allows sub json blocks' existence false if only plain HTML will be output as content

public abstract void setRequestKeys (RequestKeys newValue)

set the Request Keys object for this gui component

Parameters
newValue the RequestKeys object

public abstract void setRootWebComponent (WebComponent newValue)

set the root WebComponent for this gui component

Parameters
newValue the root WebComponent object

public abstract void setStyle (String newValue)

set the style name for the gui component. The style name is defined in the style catalog.

Parameters
newValue style name