public final class

GuiElementFactory

extends Object
java.lang.Object
   ↳ com.microstrategy.web.app.gui.GuiElementFactory

Class Overview

GuiElementFactory is the factory class for the gui elements This class is used to create instances for different GUI Element classes using its public methods. The GUI Elements can be configured by creating a file named GUIElements.properties. This file should exist in the classpath of the Application. The file specifies the actual class to be used for creating the GUI element. The name of the element is defined by the values of the constants in defined in this "CART,CART_ATTFORMS,EDITOR" and the value is the fully qualified class name for the implementation. For example, cart=com.microstrategy.web.app.gui.CartImpl editor=com.microstrategy.web.app.gui.EditorImpl

Summary

Constants
String CALENDAR
String CART
String CART_ATTFORMS
String CART_DUAL_AXIS
String CART_ELEMENT_PICKER
String CART_EXPRESSION
String CART_FONT_STYLES
String CART_OBJECT_BROWSER
String CONTACTS_CART
String EDITOR
String GUI_COMPONENT
String INCREMENTAL_FETCH
String MENU
String OBJECT_INFO_WIDGET
String QUICK_LINKS
String SCHEDULE_WIDGET
String SCROLLER
String SENDNOW_WIDGET
String SHORTCUT_ELEMENT
String SHORTCUT_LIST_ELEMENT
String SUBSCRIPTION_FILE_WIDGET
String SUBSCRIPTION_PRINT_WIDGET
String SUBSCRIPTION_WIDGET
String TOOLBAR
String TREE_BOX This constant is deprecated. Use (@link #TREE_VIEW} instead of this to render a tree view.
String TREE_CART
String TREE_CART_EXPRESSION
String TREE_VIEW Constant to specify the class name for the tree view.
String USER_ENTITIES_TREE_CART
Public Methods
static GuiElementFactory getInstance()
get the instance of the factory
GGCalendar newCalendar(AppContext context)
create a new GGCalendar gui element
Cart newCart(AppContext context)
create a new Cart object
Cart newCartAttForms(AppContext context)
create a new Cart object
CartDualAxisDistribution newCartDualAxisDistribution(AppContext context)
create a new CartFontStyles object
CartElementPicker newCartElementPicker(AppContext context)
create a new CartElementPicker object
CartExpression newCartExpression(AppContext context)
create a new CartExpression object
CartFontStyles newCartFontStyles(AppContext context)
create a new CartFontStyles object
CartObjectBrowser newCartObjectBrowser(AppContext context)
create a new CartObjectBrowser object
ContactsCart newContactsCart(AppContext context)
Editor newEditor(AppContext context)
create an Editor object
GuiComponent newGuiComponent(AppContext context)
create a new GuiComponent gui element
GuiComponent newGuiComponent()
create a new GuiComponent gui element
GuiElement newGuiElement(int guiElementType, AppContext context)
create a new gui element object by a EnumGuiElements type
IncrementalFetch newIncrementalFetch(AppContext context)
create a new IncrementalFetch object
Menu newMenu(AppContext context)
create a new Menu object
ObjectInfoWidget newObjectInfoWidget(AppContext context)
create a new ObjectInfoWidget gui element
QuickLinks newQuickLinks(AppContext context)
create a new QuickLinks object
ScheduleWidget newScheduleWidget(AppContext context)
create a new ScheduleWidget gui element
Scroller newScroller(AppContext context)
create a new Scroller object
SendNowWidget newSendNowWidget(AppContext context)
create a new SendNowWidget gui element
ShortcutElement newShortcut(AppContext context)
create a new ShortcutElement gui element
ShortcutListElement newShortcutList(AppContext context)
create a new ShortcutListElement gui element
SubscriptionFileWidget newSubscriptionFileWidget(AppContext context)
create a new SubscriptionFileWidget gui element
SubscriptionPrintWidget newSubscriptionPrintWidget(AppContext context)
create a new SubscriptionFileWidget gui element
SubscriptionWidget newSubscriptionWidget(AppContext context)
create a new SubscriptionWidget gui element
Toolbar newToolbar(AppContext context)
create a new Toolbar gui element
TreeBox newTreeBox(AppContext context)
This method is deprecated. Use newTreeView(AppContext) to render a tree component.
TreeCart newTreeCart(AppContext context)
TreeCartExpression newTreeCartExpression(AppContext context)
Create a new TreeCartExpression object
TreeView newTreeView(AppContext context)
create a new TreeView object
TreeCart newUserEntitiesTreeCart(AppContext context)
Protected Methods
Object getImplClass(String className)
Map getImplClassMap()
Returns a Map object containing the implementation name of the classes governed by this factory.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String CALENDAR

Constant Value: "calendar"

public static final String CART

Constant Value: "cart"

public static final String CART_ATTFORMS

Constant Value: "cart_attforms"

public static final String CART_DUAL_AXIS

Constant Value: "cart_dual_axis"

public static final String CART_ELEMENT_PICKER

Constant Value: "cart_element_picker"

public static final String CART_EXPRESSION

Constant Value: "cart_expression"

public static final String CART_FONT_STYLES

Constant Value: "cart_font_styles"

public static final String CART_OBJECT_BROWSER

Constant Value: "cart_object_browser"

public static final String CONTACTS_CART

Constant Value: "contacts_cart"

public static final String EDITOR

Constant Value: "editor"

public static final String GUI_COMPONENT

Constant Value: "gui_component"

public static final String INCREMENTAL_FETCH

Constant Value: "incremental_fetch"

public static final String MENU

Constant Value: "menu"

public static final String OBJECT_INFO_WIDGET

Constant Value: "object_info_widget"

public static final String QUICK_LINKS

Constant Value: "quick_links"

public static final String SCHEDULE_WIDGET

Constant Value: "schedule_widget"

public static final String SCROLLER

Constant Value: "scroller"

public static final String SENDNOW_WIDGET

Constant Value: "sendnow_widget"

public static final String SHORTCUT_ELEMENT

Constant Value: "shortcut_element"

public static final String SHORTCUT_LIST_ELEMENT

Constant Value: "shortcut_list_element"

public static final String SUBSCRIPTION_FILE_WIDGET

Constant Value: "subscription_file_widget"

public static final String SUBSCRIPTION_PRINT_WIDGET

Constant Value: "subscription_print_widget"

public static final String SUBSCRIPTION_WIDGET

Constant Value: "subscription_widget"

public static final String TOOLBAR

Constant Value: "toolbar"

public static final String TREE_BOX

This constant is deprecated.
Use (@link #TREE_VIEW} instead of this to render a tree view.

Constant Value: "tree_box"

public static final String TREE_CART

Constant Value: "tree_cart"

public static final String TREE_CART_EXPRESSION

Constant Value: "tree_cart_expression"

public static final String TREE_VIEW

Constant to specify the class name for the tree view.

Constant Value: "tree_view"

public static final String USER_ENTITIES_TREE_CART

Constant Value: "user_entities_tree_cart"

Public Methods

public static GuiElementFactory getInstance ()

get the instance of the factory

Returns
  • the instance of the factory

public GGCalendar newCalendar (AppContext context)

create a new GGCalendar gui element

Parameters
context the application context
Returns

public Cart newCart (AppContext context)

create a new Cart object

Parameters
context the application context
Returns

public Cart newCartAttForms (AppContext context)

create a new Cart object

Parameters
context the application context
Returns

public CartDualAxisDistribution newCartDualAxisDistribution (AppContext context)

create a new CartFontStyles object

Parameters
context the application context
Returns

public CartElementPicker newCartElementPicker (AppContext context)

create a new CartElementPicker object

Parameters
context the application context
Returns

public CartExpression newCartExpression (AppContext context)

create a new CartExpression object

Parameters
context the application context
Returns

public CartFontStyles newCartFontStyles (AppContext context)

create a new CartFontStyles object

Parameters
context the application context
Returns

public CartObjectBrowser newCartObjectBrowser (AppContext context)

create a new CartObjectBrowser object

Parameters
context the application context
Returns

public ContactsCart newContactsCart (AppContext context)

public Editor newEditor (AppContext context)

create an Editor object

Parameters
context the application context
Returns
  • the editor object

public GuiComponent newGuiComponent (AppContext context)

create a new GuiComponent gui element

Parameters
context the application context
Returns

public GuiComponent newGuiComponent ()

create a new GuiComponent gui element

Returns

public GuiElement newGuiElement (int guiElementType, AppContext context)

create a new gui element object by a EnumGuiElements type

Parameters
guiElementType the type of the gui element
context the application context for this gui element
Returns

public IncrementalFetch newIncrementalFetch (AppContext context)

create a new IncrementalFetch object

Parameters
context the application context
Returns

public Menu newMenu (AppContext context)

create a new Menu object

Parameters
context the application context
Returns

public ObjectInfoWidget newObjectInfoWidget (AppContext context)

create a new ObjectInfoWidget gui element

Parameters
context the application context
Returns

public QuickLinks newQuickLinks (AppContext context)

create a new QuickLinks object

Parameters
context the application context
Returns

public ScheduleWidget newScheduleWidget (AppContext context)

create a new ScheduleWidget gui element

Parameters
context the application context
Returns

public Scroller newScroller (AppContext context)

create a new Scroller object

Parameters
context the application context
Returns

public SendNowWidget newSendNowWidget (AppContext context)

create a new SendNowWidget gui element

Parameters
context the application context
Returns

public ShortcutElement newShortcut (AppContext context)

create a new ShortcutElement gui element

Parameters
context the application context
Returns

public ShortcutListElement newShortcutList (AppContext context)

create a new ShortcutListElement gui element

Parameters
context the application context
Returns

public SubscriptionFileWidget newSubscriptionFileWidget (AppContext context)

create a new SubscriptionFileWidget gui element

Parameters
context the application context
Returns

public SubscriptionPrintWidget newSubscriptionPrintWidget (AppContext context)

create a new SubscriptionFileWidget gui element

Parameters
context the application context
Returns

public SubscriptionWidget newSubscriptionWidget (AppContext context)

create a new SubscriptionWidget gui element

Parameters
context the application context
Returns

public Toolbar newToolbar (AppContext context)

create a new Toolbar gui element

Parameters
context the application context
Returns

public TreeBox newTreeBox (AppContext context)

This method is deprecated.
Use newTreeView(AppContext) to render a tree component.

create a new TreeBox object

Parameters
context the application context
Returns

public TreeCart newTreeCart (AppContext context)

public TreeCartExpression newTreeCartExpression (AppContext context)

Create a new TreeCartExpression object

Parameters
context the application context
Returns

public TreeView newTreeView (AppContext context)

create a new TreeView object

Parameters
context the application context
Returns

public TreeCart newUserEntitiesTreeCart (AppContext context)

Protected Methods

protected Object getImplClass (String className)

Parameters
className the name of the class to instanciate.
Returns
  • an Object representing the implementation class based on the class name provided.

protected Map getImplClassMap ()

Returns a Map object containing the implementation name of the classes governed by this factory.

Returns
  • a populated Map instance.