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

java.lang.Object
  org.jboss.dashboard.ui.panel.PanelDriver
      org.jboss.dashboard.ui.panel.advancedHTML.HTMLDriver

All Implemented Interfaces:

org.jboss.dashboard.workspace.export.Exportable

Direct Known Subclasses:

DashboardHTMLDriver

public class HTMLDriver
extends org.jboss.dashboard.ui.panel.PanelDriver
implements org.jboss.dashboard.workspace.export.Exportable

Controller for the HTML panel

Field Summary

static String	PARAMETER_EDITING_LANG
static String	PARAMETER_HTML
static String	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

HTMLDriver()

Method Summary

org.jboss.dashboard.ui.controller.CommandResponse	actionChangeEditingLanguage(org.jboss.dashboard.workspace.Panel panel, org.jboss.dashboard.ui.controller.CommandRequest request)
org.jboss.dashboard.ui.controller.CommandResponse	actionSaveChanges(org.jboss.dashboard.workspace.Panel panel, org.jboss.dashboard.ui.controller.CommandRequest request)
void	activateEditMode(org.jboss.dashboard.workspace.Panel panel, org.jboss.dashboard.ui.controller.CommandRequest request) Defines the action to be taken when activating edit mode
void	activateNormalMode(org.jboss.dashboard.workspace.Panel panel, org.jboss.dashboard.ui.controller.CommandRequest request) Defines the action to be taken when activating edit mode
protected void	beforePanelInstanceRemove(org.jboss.dashboard.workspace.PanelInstance instance)
void	exportContent(org.jboss.dashboard.workspace.PanelInstance instance, OutputStream os) Write instance content to given OutputStream, which must not be closed.
int	getEditHeight(org.jboss.dashboard.workspace.Panel panel, org.jboss.dashboard.ui.controller.CommandRequest request)
String	getEditingLanguage(org.jboss.dashboard.workspace.Panel panel) Determine the editing language.
int	getEditWidth(org.jboss.dashboard.workspace.Panel panel, org.jboss.dashboard.ui.controller.CommandRequest request)
Map<String,String>	getHtmlCode(org.jboss.dashboard.workspace.Panel panel) Determine the text being shown for given panel.
protected String	getPanelHTMLContent(org.jboss.dashboard.workspace.PanelInstance instance, String lang)
void	importContent(org.jboss.dashboard.workspace.PanelInstance instance, InputStream is) Read instance content from given InputStream, which must not be closed.
void	init(org.jboss.dashboard.ui.panel.PanelProvider provider)
void	initPanelSession(org.jboss.dashboard.workspace.PanelSession status, javax.servlet.http.HttpSession session)
boolean	isUsingDefaultLanguage(org.jboss.dashboard.workspace.Panel panel) Returns if this driver is using default language
boolean	isUsingDefaultLanguage(org.jboss.dashboard.workspace.PanelInstance panel) Returns if this driver is using default language
HTMLText	load(org.jboss.dashboard.workspace.PanelInstance instance)
void	replicateData(org.jboss.dashboard.workspace.PanelInstance src, org.jboss.dashboard.workspace.PanelInstance dest) Replicates panel data.
boolean	supportsEditMode(org.jboss.dashboard.workspace.Panel panel) Returns if this driver defines support to activate edit mode.
protected Map<String,String>	toEditableObject(HTMLText text)

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

PARAMETER_HTML

public static final String PARAMETER_HTML

See Also:

Constant Field Values

PARAMETER_EDITING_LANG

public static final String PARAMETER_EDITING_LANG

See Also:

Constant Field Values

PARAMETER_USE_DEFAULTS

public static final String PARAMETER_USE_DEFAULTS

See Also:

Constant Field Values

Constructor Detail

HTMLDriver

public HTMLDriver()

Method Detail

init

public void init(org.jboss.dashboard.ui.panel.PanelProvider provider)
          throws Exception

Overrides:

init in class org.jboss.dashboard.ui.panel.PanelDriver

Throws:

Exception

initPanelSession

public void initPanelSession(org.jboss.dashboard.workspace.PanelSession status,
                             javax.servlet.http.HttpSession session)

Overrides:

initPanelSession in class org.jboss.dashboard.ui.panel.PanelDriver

beforePanelInstanceRemove

protected void beforePanelInstanceRemove(org.jboss.dashboard.workspace.PanelInstance instance)
                                  throws Exception

Overrides:

beforePanelInstanceRemove in class org.jboss.dashboard.ui.panel.PanelDriver

Throws:

Exception

supportsEditMode

public boolean supportsEditMode(org.jboss.dashboard.workspace.Panel panel)

Returns if this driver defines support to activate edit mode.

Overrides:

supportsEditMode in class org.jboss.dashboard.ui.panel.PanelDriver

getEditWidth

public int getEditWidth(org.jboss.dashboard.workspace.Panel panel,
                        org.jboss.dashboard.ui.controller.CommandRequest request)

Overrides:

getEditWidth in class org.jboss.dashboard.ui.panel.PanelDriver

getEditHeight

public int getEditHeight(org.jboss.dashboard.workspace.Panel panel,
                         org.jboss.dashboard.ui.controller.CommandRequest request)

Overrides:

getEditHeight in class org.jboss.dashboard.ui.panel.PanelDriver

activateEditMode

public void activateEditMode(org.jboss.dashboard.workspace.Panel panel,
                             org.jboss.dashboard.ui.controller.CommandRequest request)
                      throws Exception

Defines the action to be taken when activating edit mode

Overrides:

activateEditMode in class org.jboss.dashboard.ui.panel.PanelDriver

Throws:

Exception

toEditableObject

protected Map<String,String> toEditableObject(HTMLText text)

activateNormalMode

public void activateNormalMode(org.jboss.dashboard.workspace.Panel panel,
                               org.jboss.dashboard.ui.controller.CommandRequest request)
                        throws Exception

Defines the action to be taken when activating edit mode

Overrides:

activateNormalMode in class org.jboss.dashboard.ui.panel.PanelDriver

Throws:

Exception

isUsingDefaultLanguage

public boolean isUsingDefaultLanguage(org.jboss.dashboard.workspace.Panel panel)

Returns if this driver is using default language

Parameters:

panel -

Returns:

if this driver is using default language

isUsingDefaultLanguage

public boolean isUsingDefaultLanguage(org.jboss.dashboard.workspace.PanelInstance panel)

Returns if this driver is using default language

Parameters:

panel -

Returns:

if this driver is using default language

getHtmlCode

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

Determine the text being shown for given panel.

Parameters:

panel -

Returns:

The text shown, i18n.

getEditingLanguage

public String getEditingLanguage(org.jboss.dashboard.workspace.Panel panel)

Determine the editing language.

Returns:

The text shown, i18n.

actionChangeEditingLanguage

public org.jboss.dashboard.ui.controller.CommandResponse actionChangeEditingLanguage(org.jboss.dashboard.workspace.Panel panel,
                                                                                     org.jboss.dashboard.ui.controller.CommandRequest request)
                                                                              throws Exception

Throws:

Exception

actionSaveChanges

public org.jboss.dashboard.ui.controller.CommandResponse actionSaveChanges(org.jboss.dashboard.workspace.Panel panel,
                                                                           org.jboss.dashboard.ui.controller.CommandRequest request)
                                                                    throws Exception

Throws:

Exception

load

public HTMLText load(org.jboss.dashboard.workspace.PanelInstance instance)

replicateData

public void replicateData(org.jboss.dashboard.workspace.PanelInstance src,
                          org.jboss.dashboard.workspace.PanelInstance dest)
                   throws Exception

Replicates panel data.

Overrides:

replicateData in class org.jboss.dashboard.ui.panel.PanelDriver

Parameters:

src - Source PanelInstance

dest - Destinaton PanelInstance

Throws:

Exception

exportContent

public void exportContent(org.jboss.dashboard.workspace.PanelInstance instance,
                          OutputStream os)
                   throws Exception

Write instance content to given OutputStream, which must not be closed.

Specified by:

exportContent in interface org.jboss.dashboard.workspace.export.Exportable

Throws:

Exception

importContent

public void importContent(org.jboss.dashboard.workspace.PanelInstance instance,
                          InputStream is)
                   throws Exception

Read instance content from given InputStream, which must not be closed.

Specified by:

importContent in interface org.jboss.dashboard.workspace.export.Exportable

Throws:

Exception

getPanelHTMLContent

protected String getPanelHTMLContent(org.jboss.dashboard.workspace.PanelInstance instance,
                                     String lang)

Overrides:

getPanelHTMLContent in class org.jboss.dashboard.ui.panel.PanelDriver