org.jboss.dashboard.ui.panel.dashboard

Class DashboardHTMLDriver

java.lang.Object

org.jboss.dashboard.ui.panel.PanelDriver

org.jboss.dashboard.ui.panel.advancedHTML.HTMLDriver

org.jboss.dashboard.ui.panel.dashboard.DashboardHTMLDriver

All Implemented Interfaces:

org.jboss.dashboard.ui.panel.DashboardDriver, org.jboss.dashboard.workspace.export.Exportable

public class DashboardHTMLDriver
extends HTMLDriver
implements org.jboss.dashboard.ui.panel.DashboardDriver

Extension of the HTML base panel that makes possible to embed inside the HTML dashboard variables.

For example, it's possible to display, as a part of an HTML fragment, the number of running cases that a given dashboard KPI is displaying, or the total amount of sales made in a given period. The following HTML fragment is an example of how to do that. Suppose we want to display the following HTML fragment:
€ 9600K Total sales between January 1st, 2008 and July 31st, 2008.
As we can see we got 3 dynamic variables extracted from the dashboard context. The HTML source that prints the previous HTML is: <b>&#36; {dashboard_sumfunction, order_amount} Total sales between {dashboard_minvalue, date} and {dashboard_maxvalue, date}</b> Each command is replaced by:

• {dashboard_sumfunction, order_amount} => € 9600K
• {dashboard_minvalue, date} => January 1st, 2008
• {dashboard_maxvalue, date} => July 31st, 2008

So with a simple command mechanism the HTML editor can mix HTML static code with information displayed by the dashboard's KPIs. Next is a list fo some commands available:
Data property commands. Access the dashboard data filter current status:

• {dashboard_minvalue, <propertyId>} => The minimum data filter value defined for a property.
• {dashboard_maxvalue, <propertyId>} => The maximum data filter value defined for a property.
• {dashboard_selectedvalues, <propertyId>} => The filter values the user has entered.
• {dashboard_allvalues, <propertyId>} => All the filter allowed values.

<propertyId> must be replaced by a property identifier belonging to the list of properties loaded by the data providers contained in the dashboard. So we got a data provider that loads, for instance, an order_amount property, then we could extract information of that property using those commands.

Function commands. Apply an scalar function over the values loaded for a given property:

• {dashboard_count, <propertyId>} => The number of occurrences or values a given property has.
• {dashboard_distinct, <propertyId>} => The number of different occurrences a given property has.
• {dashboard_max, <propertyId>} => The maximum value for a given property.
• {dashboard_min, <propertyId>} => The minimum value for a given property.
• {dashboard_average, <propertyId>} => The average value for a given property.
• {dashboard_sum, <propertyId>} => The sum of all the values for a given property.

The last 4 commands can only be applied to numeric properties.

Navigations commands. Give access to the user navigation context within the workspace:

• {navigation_workspace_id} => The current workspace identifier.
• {navigation_workspace_title} => The current workspace title localized in the user language.
• {navigation_page_id} => The current page identifier.
• {navigation_page_title} => The current page title localized in the user language.
• {navigation_language} => The current language (es, en, ca, ...)
• {navigation_user_login} => The logged user login.
• {navigation_user_name} => The logged user name.
• {navigation_user_email} => The logged user e-mail.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log Logger

Fields inherited from class org.jboss.dashboard.ui.panel.advancedHTML.HTMLDriver

PARAMETER_EDITING_LANG, PARAMETER_HTML, PARAMETER_USE_DEFAULTS

Fields inherited from class org.jboss.dashboard.ui.panel.PanelDriver

PAGE_HEADER, PAGE_HELP_MODE, PAGE_MANAGE_INVALID_DRIVER, panelSecurity, PARAMETER_ACTION_EXECUTED_ENABLED, parameters

Constructor Summary

Constructors

Constructor and Description
DashboardHTMLDriver()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getHtmlCode(org.jboss.dashboard.workspace.Panel panel) OVERRIDDEN in order to process commands embedded in the HTML.
Set<String>	getPropertiesReferenced(org.jboss.dashboard.workspace.Panel panel)

Methods inherited from class org.jboss.dashboard.ui.panel.advancedHTML.HTMLDriver

actionChangeEditingLanguage, actionSaveChanges, activateEditMode, activateNormalMode, beforePanelInstanceRemove, exportContent, getEditHeight, getEditingLanguage, getEditWidth, getPanelHTMLContent, importContent, init, initPanelSession, isUsingDefaultLanguage, isUsingDefaultLanguage, load, replicateData, supportsEditMode, toEditableObject

Methods inherited from class org.jboss.dashboard.ui.panel.PanelDriver

_execute, actionChangePage, activateConfigMode, activateHelpMode, addMethodPermission, addParameter, addParameters, addSystemParameter, afterInvokeAction, afterPanelClosed, afterPanelCustomPropertiesModified, afterPanelPlacedInRegion, afterPanelPropertiesModified, afterRenderPanel, beforeInvokeAction, beforePanelClosed, beforePanelInstanceRemove, beforePanelPlacedInRegion, beforePanelRemoved, beforeRenderPanel, canInvokeAction, checkInvokeAction, checkMethodSecurity, copyDirectory, copyFile, execute, fireAfterInvokeAction, fireAfterPanelClosed, fireAfterPanelPlacedInRegion, fireAfterRenderPanel, fireBeforeInvokeAction, fireBeforePanelInstanceRemove, fireBeforePanelPlacedInRegion, fireBeforePanelRemoved, fireBeforeRenderPanel, firePanelCustomPropertiesModified, firePanelPropertiesModified, getActionsBundle, getAllParameters, getConfigHeight, getConfigWidth, getHelpHeight, getHelpWidth, getMethodName, getPageEdit, getPageHelpMode, getPanelDir, getPanelDir, getPanelDirMapping, getPanelDirMapping, getPanelSession, getPanelSession, getPanelSession, getResourceForPermission, getShowPanelPageComponent, getTextShownByInstance, getURLWhenMaximized, hasMethodAccess, initPanel, initPermissionsParameters, initSystemParameters, isDoubleClickProtected, isSystemAction, move, panelActionClose, panelActionEditMode, panelActionFactory, panelActionHelpMode, panelActionInvalidateCache, panelActionMaximize, panelActionMaximizeInRegion, panelActionMinimize, panelActionMoveBack, panelActionMoveForward, panelActionRefreshPanel, panelActionRemove, panelActionRestore, panelActionSelect, panelActionShowMode, panelActionStartConfig, supportsHelpMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static transient org.slf4j.Logger log

Logger

Constructor Detail

DashboardHTMLDriver

public DashboardHTMLDriver()

Method Detail

getHtmlCode

public Map<String,String> getHtmlCode(org.jboss.dashboard.workspace.Panel panel)

OVERRIDDEN in order to process commands embedded in the HTML.

Overrides:

getHtmlCode in class HTMLDriver

Returns:

The text shown, i18n.

getPropertiesReferenced

public Set<String> getPropertiesReferenced(org.jboss.dashboard.workspace.Panel panel)
                                    throws Exception

Specified by:

getPropertiesReferenced in interface org.jboss.dashboard.ui.panel.DashboardDriver

Throws:

Exception