java.lang.Object
- com.microstrategy.web.app.gui.GuiElementFactory

```
public final class GuiElementFactory
extends java.lang.Object
```
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

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`CALENDAR`
`static java.lang.String`	`CART`
`static java.lang.String`	`CART_ATTFORMS`
`static java.lang.String`	`CART_DUAL_AXIS`
`static java.lang.String`	`CART_ELEMENT_PICKER`
`static java.lang.String`	`CART_EXPRESSION`
`static java.lang.String`	`CART_FONT_STYLES`
`static java.lang.String`	`CART_OBJECT_BROWSER`
`static java.lang.String`	`CONTACTS_CART`
`static java.lang.String`	`EDITOR`
`static java.lang.String`	`GUI_COMPONENT`
`static java.lang.String`	`INCREMENTAL_FETCH`
`static java.lang.String`	`MENU`
`static java.lang.String`	`OBJECT_INFO_WIDGET`
`static java.lang.String`	`QUICK_LINKS`
`static java.lang.String`	`SCHEDULE_WIDGET`
`static java.lang.String`	`SCROLLER`
`static java.lang.String`	`SENDNOW_WIDGET`
`static java.lang.String`	`SHORTCUT_ELEMENT`
`static java.lang.String`	`SHORTCUT_LIST_ELEMENT`
`static java.lang.String`	`SUBSCRIPTION_FILE_WIDGET`
`static java.lang.String`	`SUBSCRIPTION_PRINT_WIDGET`
`static java.lang.String`	`SUBSCRIPTION_WIDGET`
`static java.lang.String`	`TOOLBAR`
`static java.lang.String`	`TREE_BOX`	Deprecated. Use (@link #TREE_VIEW} instead of this to render a tree view.
`static java.lang.String`	`TREE_CART`
`static java.lang.String`	`TREE_CART_EXPRESSION`
`static java.lang.String`	`TREE_VIEW`	Constant to specify the class name for the tree view.
`static java.lang.String`	`USER_ENTITIES_TREE_CART`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected java.lang.Object`	`getImplClass(java.lang.String className)`
`protected java.util.Map`	`getImplClassMap()`	Returns a Map object containing the implementation name of the classes governed by this factory.
`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()`	create a new `GuiComponent` gui element
`GuiComponent`	`newGuiComponent(AppContext context)`	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)`	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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CALENDAR
```
public static final java.lang.String CALENDAR
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - CART
```
public static final java.lang.String CART
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - CART_ATTFORMS
```
public static final java.lang.String CART_ATTFORMS
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - CART_EXPRESSION
```
public static final java.lang.String CART_EXPRESSION
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TREE_CART
```
public static final java.lang.String TREE_CART
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - USER_ENTITIES_TREE_CART
```
public static final java.lang.String USER_ENTITIES_TREE_CART
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - CART_FONT_STYLES
```
public static final java.lang.String CART_FONT_STYLES
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - CART_DUAL_AXIS
```
public static final java.lang.String CART_DUAL_AXIS
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - CART_OBJECT_BROWSER
```
public static final java.lang.String CART_OBJECT_BROWSER
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - CART_ELEMENT_PICKER
```
public static final java.lang.String CART_ELEMENT_PICKER
```
    Since:
    
    MicroStrategy Web 8.0.1
    
    See Also:
    
    Constant Field Values
  - EDITOR
```
public static final java.lang.String EDITOR
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - GUI_COMPONENT
```
public static final java.lang.String GUI_COMPONENT
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - INCREMENTAL_FETCH
```
public static final java.lang.String INCREMENTAL_FETCH
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - SCROLLER
```
public static final java.lang.String SCROLLER
```
    Since:
    
    MicroStrategy Web 8.1.0
    
    See Also:
    
    Constant Field Values
  - MENU
```
public static final java.lang.String MENU
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - OBJECT_INFO_WIDGET
```
public static final java.lang.String OBJECT_INFO_WIDGET
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - QUICK_LINKS
```
public static final java.lang.String QUICK_LINKS
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - SCHEDULE_WIDGET
```
public static final java.lang.String SCHEDULE_WIDGET
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - SENDNOW_WIDGET
```
public static final java.lang.String SENDNOW_WIDGET
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - SHORTCUT_ELEMENT
```
public static final java.lang.String SHORTCUT_ELEMENT
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - SHORTCUT_LIST_ELEMENT
```
public static final java.lang.String SHORTCUT_LIST_ELEMENT
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - SUBSCRIPTION_FILE_WIDGET
```
public static final java.lang.String SUBSCRIPTION_FILE_WIDGET
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - SUBSCRIPTION_PRINT_WIDGET
```
public static final java.lang.String SUBSCRIPTION_PRINT_WIDGET
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - SUBSCRIPTION_WIDGET
```
public static final java.lang.String SUBSCRIPTION_WIDGET
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TOOLBAR
```
public static final java.lang.String TOOLBAR
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TREE_BOX
```
public static final java.lang.String TREE_BOX
```
    Deprecated.
    Use (@link #TREE_VIEW} instead of this to render a tree view.
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TREE_VIEW
```
public static final java.lang.String TREE_VIEW
```
    Constant to specify the class name for the tree view.
    
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - TREE_CART_EXPRESSION
```
public static final java.lang.String TREE_CART_EXPRESSION
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - CONTACTS_CART
```
public static final java.lang.String CONTACTS_CART
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static GuiElementFactory getInstance()
```
    get the instance of the factory
    
    Returns:
    
    the instance of the factory
  - newGuiElement
```
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:
    
    the GuiElement object
  - newEditor
```
public Editor newEditor(AppContext context)
```
    create an Editor object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the editor object
  - newQuickLinks
```
public QuickLinks newQuickLinks(AppContext context)
```
    create a new QuickLinks object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the QuickLinks object
  - newMenu
```
public Menu newMenu(AppContext context)
```
    create a new Menu object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the Menu object
  - newCart
```
public Cart newCart(AppContext context)
```
    create a new Cart object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the Cart object
  - newCartExpression
```
public CartExpression newCartExpression(AppContext context)
```
    create a new CartExpression object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the CartExpression object
  - newTreeCart
```
public TreeCart newTreeCart(AppContext context)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - newUserEntitiesTreeCart
```
public TreeCart newUserEntitiesTreeCart(AppContext context)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - newCartFontStyles
```
public CartFontStyles newCartFontStyles(AppContext context)
```
    create a new CartFontStyles object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the CartFontStyles object
  - newCartDualAxisDistribution
```
public CartDualAxisDistribution newCartDualAxisDistribution(AppContext context)
```
    create a new CartFontStyles object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the CartDualAxisDistribution object
    
    Since:
    
    MicroStrategy Web 9.0.0
  - newCartObjectBrowser
```
public CartObjectBrowser newCartObjectBrowser(AppContext context)
```
    create a new CartObjectBrowser object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the CartObjectBrowser object
    
    Since:
    
    MicroStrategy Web 8.0.0
  - newCartElementPicker
```
public CartElementPicker newCartElementPicker(AppContext context)
```
    create a new CartElementPicker object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the CartElementPicker object
    
    Since:
    
    MicroStrategy Web 8.0.1
  - newContactsCart
```
public ContactsCart newContactsCart(AppContext context)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - newCartAttForms
```
public Cart newCartAttForms(AppContext context)
```
    create a new Cart object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the Cart object
    
    Since:
    
    MicroStrategy Web 8.0.0
  - newTreeCartExpression
```
public TreeCartExpression newTreeCartExpression(AppContext context)
```
    Create a new TreeCartExpression object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the TreeCartExpression object
    
    Since:
    
    MicroStrategy Web 7.5.0
  - newTreeBox
```
public TreeBox newTreeBox(AppContext context)
```
    Deprecated.
    Use newTreeView(AppContext) to render a tree component.
    
    create a new TreeBox object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the TreeBox object
    
    Since:
    
    MicroStrategy Web 7.5.0
  - newTreeView
```
public TreeView newTreeView(AppContext context)
```
    create a new TreeView object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the TreeView object
    
    Since:
    
    MicroStrategy Web 9.0.0
  - newIncrementalFetch
```
public IncrementalFetch newIncrementalFetch(AppContext context)
```
    create a new IncrementalFetch object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the IncrementalFetch object
  - newScroller
```
public Scroller newScroller(AppContext context)
```
    create a new Scroller object
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the Scroller object
    
    Since:
    
    MicroStrategy Web 8.1.0
  - newCalendar
```
public GGCalendar newCalendar(AppContext context)
```
    create a new GGCalendar gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the GGCalendar object
  - newSubscriptionWidget
```
public SubscriptionWidget newSubscriptionWidget(AppContext context)
```
    create a new SubscriptionWidget gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the SubscriptionWidget object
  - newSubscriptionFileWidget
```
public SubscriptionFileWidget newSubscriptionFileWidget(AppContext context)
```
    create a new SubscriptionFileWidget gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the SubscriptionFileWidget object
    
    Since:
    
    MicroStrategy Web 7.5.1
  - newSubscriptionPrintWidget
```
public SubscriptionPrintWidget newSubscriptionPrintWidget(AppContext context)
```
    create a new SubscriptionFileWidget gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the SubscriptionFileWidget object
    
    Since:
    
    MicroStrategy Web 7.5.1
  - newScheduleWidget
```
public ScheduleWidget newScheduleWidget(AppContext context)
```
    create a new ScheduleWidget gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the ScheduleWidget object
  - newSendNowWidget
```
public SendNowWidget newSendNowWidget(AppContext context)
```
    create a new SendNowWidget gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the SendNowWidget object
  - newObjectInfoWidget
```
public ObjectInfoWidget newObjectInfoWidget(AppContext context)
```
    create a new ObjectInfoWidget gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the ObjectInfoWidget object
  - newToolbar
```
public Toolbar newToolbar(AppContext context)
```
    create a new Toolbar gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the Toolbar object
    
    Since:
    
    MicroStrategy Web 8.0.0
  - newShortcutList
```
public ShortcutListElement newShortcutList(AppContext context)
```
    create a new ShortcutListElement gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the ShortcutListElement object
    
    Since:
    
    MicroStrategy Web 8.0.0
  - newShortcut
```
public ShortcutElement newShortcut(AppContext context)
```
    create a new ShortcutElement gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the ShortcutElement object
    
    Since:
    
    MicroStrategy Web 8.0.0
  - newGuiComponent
```
public GuiComponent newGuiComponent(AppContext context)
```
    create a new GuiComponent gui element
    
    Parameters:
    
    context - the application context
    
    Returns:
    
    the GuiComponent object
  - newGuiComponent
```
public GuiComponent newGuiComponent()
```
    create a new GuiComponent gui element
    
    Returns:
    
    the GuiComponent object
  - getImplClassMap
```
protected java.util.Map getImplClassMap()
```
    Returns a Map object containing the implementation name of the classes governed by this factory.
    
    Returns:
    
    a populated Map instance.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getImplClass
```
protected java.lang.Object getImplClass(java.lang.String className)
```
    Parameters:
    
    className - the name of the class to instanciate.
    
    Returns:
    
    an Object representing the implementation class based on the class name provided.
    
    Since:
    
    MicroStrategy Web 8.0.0

Class GuiElementFactory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CALENDAR

CART

CART_ATTFORMS

CART_EXPRESSION

TREE_CART

USER_ENTITIES_TREE_CART

CART_FONT_STYLES

CART_DUAL_AXIS

CART_OBJECT_BROWSER

CART_ELEMENT_PICKER

EDITOR

GUI_COMPONENT

INCREMENTAL_FETCH

SCROLLER

MENU

OBJECT_INFO_WIDGET

QUICK_LINKS

SCHEDULE_WIDGET

SENDNOW_WIDGET

SHORTCUT_ELEMENT

SHORTCUT_LIST_ELEMENT

SUBSCRIPTION_FILE_WIDGET

SUBSCRIPTION_PRINT_WIDGET

SUBSCRIPTION_WIDGET

TOOLBAR

TREE_BOX

TREE_VIEW

TREE_CART_EXPRESSION

CONTACTS_CART

Method Detail

getInstance

newGuiElement

newEditor

newQuickLinks

newMenu

newCart

newCartExpression

newTreeCart

newUserEntitiesTreeCart

newCartFontStyles

newCartDualAxisDistribution

newCartObjectBrowser

newCartElementPicker

newContactsCart

newCartAttForms

newTreeCartExpression

newTreeBox

newTreeView

newIncrementalFetch

newScroller

newCalendar

newSubscriptionWidget

newSubscriptionFileWidget

newSubscriptionPrintWidget

newScheduleWidget

newSendNowWidget

newObjectInfoWidget

newToolbar

newShortcutList

newShortcut

newGuiComponent

newGuiComponent

getImplClassMap

getImplClass