com.jalios.jcmsplugin.virtualdesktop
Class DesktopHandler

java.lang.Object
  com.jalios.jcms.context.JcmsContext
      com.jalios.jcms.context.JcmsJspContext
          com.jalios.jcmsplugin.virtualdesktop.DesktopHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class DesktopHandler
extends JcmsJspContext

DesktopHandler is a JavaBean which retrieves and updates a Desktop instance.

Since:

virtualdesktop-1.0

Version:

$Revision: 22731 $

Nested Class Summary

static class

DesktopHandler.Action Actions performed by this handler

Field Summary

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

BODY_HEADER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, JS_HEADER, jsboMap, jsboSet, jsfoMap, jsfoSet, out, pageContext, REVISION, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDebug, isLogged, loggedMember, request, response, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DAILY_MAIL_ALERT, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, MONTHLY_MAIL_ALERT, NO_MAIL_ALERT, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WEEKLY_MAIL_ALERT, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

DesktopHandler()

Method Summary

Desktop	getDesktop() Retrieves the Desktop instance managed by this handler.
Service	getService() Retrieve the Service being modified.
void	setAction(String action) Set the action to be performed by this DesktopHandler
void	setColumnNbr(int colNbr) Sets the number of column to use for the current tab.
void	setColumnsIds(String[] ids) Set the ids of the columns to be modified.
void	setColumnsWidth(double[] widths) Set the column width for the current tab.
void	setCss(String css) Set the css name to use for the desktop.
void	setFeedUrl(String url) Set the feed URL for DesktopHandler.Action.ADD_FEED action.
void	setIcon(String iconName) Set the icon name to use for the current tab.
void	setPortletId(String id) Set the portlet Id to be used for the new service.
void	setServiceId(String id) Set the id of the Service to be modified
void	setShowTitle(String showTitleStr) Set whether the desktop title should be displayed or not.
void	setTabId(String id) Set the id of the tab to be modified.
void	setTabIds(String[] ids) Set the ids of the tabs in the correct order.
void	setTitle(String title) Set the title to be updated for the current DesktopElement being modified
boolean	validate() Retrieves and updates the Desktop associated to current user/session.

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJSHeader, addJSHeader, addJSHeader, addJSHeader, addStyleHeader, addStyleHeader, debugDisplayContext, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBackOfficeJSHeader, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getFrontOfficeJSHeader, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSHeaders, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isPrintView, registerDisplayContext, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getInfoMsg, getLoggedMember, getRequest, getResponse, getSession, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserLang, getUserLocale, getWarningMsg, getWorkspace, glp, isAdmin, isAjaxRequest, isDebug, isInFrontOffice, isLogged, isWebdavAccess, retrieveUploadedFile, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp

Methods inherited from class java.lang.Object

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

Constructor Detail

DesktopHandler

public DesktopHandler()

Method Detail

validate

public boolean validate()
                 throws IOException

Retrieves and updates the Desktop associated to current user/session.

Returns:

true if the validation was successful, false otherwise (in the later case, not other operation on the handler should be performed)

Throws:

IOException

getDesktop

public Desktop getDesktop()

Retrieves the Desktop instance managed by this handler.
This method MUST be called after a call to the validate method which performs the retrieval of the Desktop

Returns:

the Desktop instance associated to current user/session

setAction

public void setAction(String action)

Set the action to be performed by this DesktopHandler

Parameters:

action - an action name from the enum values DesktopHandler.Action, e.g. "ADD_SERVICE"

setTabId

public void setTabId(String id)

Set the id of the tab to be modified.

Parameters:

id - a tab id from the current desktop.

setTabIds

public void setTabIds(String[] ids)

Set the ids of the tabs in the correct order.

Only used with action DesktopHandler.Action.REORDER_TAB.

Parameters:

ids - the tab ids

setColumnsIds

public void setColumnsIds(String[] ids)

Set the ids of the columns to be modified.

Only used with action DesktopHandler.Action.UPDATE_COLUMNS.
For each column, a parameter with the column id as the name and the column's services ids must be specified. Example : columnsIds=c1&columnsIds=c2&c1=s1&c1=s2&c2=s3

Parameters:

ids - the column ids

setPortletId

public void setPortletId(String id)

Set the portlet Id to be used for the new service.

Only used with action DesktopHandler.Action.ADD_SERVICE.

Parameters:

id - a serviceable portlet id

setServiceId

public void setServiceId(String id)

Set the id of the Service to be modified

Parameters:

id - a service id

setTitle

public void setTitle(String title)

Set the title to be updated for the current DesktopElement being modified

Parameters:

title - any title

setShowTitle

public void setShowTitle(String showTitleStr)

Set whether the desktop title should be displayed or not.

Parameters:

showTitleStr - "true" to display the title, "false" otherwise

setCss

public void setCss(String css)

Set the css name to use for the desktop.

Parameters:

css - an css theme name as returned by DesktopManager.getThemes()

setIcon

public void setIcon(String iconName)

Set the icon name to use for the current tab.

Only used with action DesktopHandler.Action.UPDATE_TAB.

Parameters:

iconName - an icon name as returned by DesktopManager.getIcons()

setColumnNbr

public void setColumnNbr(int colNbr)

Sets the number of column to use for the current tab.

Only used with action DesktopHandler.Action.UPDATE_TAB.

Parameters:

colNbr - number of column

setColumnsWidth

public void setColumnsWidth(double[] widths)

Set the column width for the current tab.

Only used with action DesktopHandler.Action.UPDATE_TAB.

Parameters:

widths - an array of width in percent, (e.g {33.3,66.6)). length of this array must be the same as the number of columns in the current tab.

setFeedUrl

public void setFeedUrl(String url)

Set the feed URL for DesktopHandler.Action.ADD_FEED action.

Parameters:

url - an RSS feed URL;

getService

public Service getService()

Retrieve the Service being modified.

Returns:

the current Service being modified or null if it could not be found or if the current handler operation does not take place on a