org.opencms.workplace
Class CmsWorkplace

java.lang.Object
  org.opencms.workplace.CmsWorkplace

Direct Known Subclasses:

CmsEditorHandler, CmsExplorer, CmsFrameset, CmsToolDialog, CmsTree

public abstract class CmsWorkplace

extends Object

Master class for the JSP based workplace which provides default methods and session handling for all JSP workplace classes.

Since:

6.0.0

Version:

$Revision: 1.145 $

Author:

Alexander Kandzior

Field Summary

static boolean	DEBUG The debug flag.
static String	DEFAULT_LANGUAGE Parameter for the default language.
static Locale	DEFAULT_LOCALE Parameter for the default locale.
protected static String	DIALOG_PATH_COMMON Constant for the JSP common files (e.g.
protected static String	FILE_DIALOG_CLOSE Constant for the JSP common close dialog page.
protected static String	FILE_DIALOG_SCREEN_CONFIRM Constant for the JSP common confirmation dialog.
protected static String	FILE_DIALOG_SCREEN_ERROR Constant for the JSP common error dialog.
protected static String	FILE_DIALOG_SCREEN_ERRORPAGE Constant for the JSP common error dialog.
protected static String	FILE_DIALOG_SCREEN_WAIT Constant for the JSP common wait screen.
static String	FILE_EXPLORER_FILELIST Constant for the JSP explorer filelist file.
protected static String	FILE_REPORT_OUTPUT Constant for the JSP common report page.
static int	HTML_END Helper variable to deliver the html end part.
static int	HTML_START Helper variable to deliver the html start part.
static String	PATH_DIALOGS Constant for the JSP dialogs path.
static String	PATH_WORKPLACE Constant for the JSP workplace path.
protected static String	REQUEST_ATTRIBUTE_MULTIPART Key name for the request attribute to indicate a multipart request was already parsed.
protected static String	REQUEST_ATTRIBUTE_RELOADTREE Key name for the request attribute to reload the folder tree view.
static String	RFS_PATH_RESOURCES Path to exported system image folder.
protected static String	SESSION_WORKPLACE_CLASS Key name for the session workplace class.
static String	TEMP_FILE_PREFIX Prefix for temporary files in the VFS.
static String	VFS_DIR_DEFAULTBODIES Directory name of content default_bodies folder.
static String	VFS_DIR_TEMPLATES Directory name of content templates folder.
static String	VFS_PATH_GALLERIES Path to the galleries.
static String	VFS_PATH_LOCALES Path to locales.
static String	VFS_PATH_MODULES Path to modules folder.
static String	VFS_PATH_RESOURCES Path to system image folder.
static String	VFS_PATH_SYSTEM Path to system folder.
static String	VFS_PATH_VIEWS Path to workplace views.
static String	VFS_PATH_WORKPLACE Path to the workplace.

Constructor Summary

CmsWorkplace(CmsJspActionElement jsp)
Public constructor.

CmsWorkplace(PageContext context, HttpServletRequest req, HttpServletResponse res)
Public constructor with JSP variables.

Method Summary

protected void	addMessages(String bundleName) Auxiliary method for initialization of messages.
String	allParamsAsHidden() Returns all parameters of the current workplace class as hidden field tags that can be inserted in a form.
String	allParamsAsRequest() Returns all present request parameters as String.
protected Map	allParamValues() Returns the values of all parameter methods of this workplace class instance.
String	bodyEnd() Builds the end html of the body.
String	bodyStart(String className) Builds the start html of the body.
String	bodyStart(String className, String parameters) Builds the start html of the body.
String	buildSelect(String parameters, List options, List values, int selected) Generates a html select box out of the provided values.
static String	buildSelect(String parameters, List options, List values, int selected, boolean useLineFeed) Generates a html select box out of the provided values.
String	button(String href, String target, String image, String label, int type) Generates a button for the OpenCms workplace.
String	button(String href, String target, String image, String label, int type, String imagePath) Generates a button for the OpenCms workplace.
String	buttonBar(int segment) Returns the html for a button bar.
String	buttonBar(int segment, String attributes) Returns the html for a button bar.
String	buttonBarHorizontalLine() Generates a horizontal button bar separator line with maximum width.
String	buttonBarLabel(String label) Generates a button bar label.
String	buttonBarLabel(String label, String className) Generates a button bar label.
String	buttonBarLine(int leftPixel, int rightPixel, String className) Generates a variable button bar separator line.
String	buttonBarLineSpacer(int pixel) Generates a variable button bar separator line spacer.
String	buttonBarSeparator(int leftPixel, int rightPixel) Generates a button bar separator.
String	buttonBarSpacer(int width) Returns the html for an invisible spacer between button bar contents like buttons, labels, etc.
String	buttonBarStartTab(int leftPixel, int rightPixel) Generates a button bar starter tab.
String	calendarIncludes() Displays a javascript calendar element with the standard "opencms" style.
String	calendarIncludes(String style) Displays a javascript calendar element.
String	calendarInit(String inputFieldId, String triggerButtonId, String align, boolean singleClick, boolean weekNumbers, boolean mondayFirst, String dateStatusFunc) Initializes a javascript calendar element to be shown on a page.
String	calendarInit(String inputFieldId, String triggerButtonId, String align, boolean singleClick, boolean weekNumbers, boolean mondayFirst, String dateStatusFunc, boolean showTime) Initializes a javascript calendar element to be shown on a page.
void	checkLock(String resource) Checks the lock state of the resource and locks it if the autolock feature is enabled.
void	checkLock(String resource, int mode) Checks the lock state of the resource and locks it if the autolock feature is enabled.
protected String	decodeParamValue(String paramName, String paramValue) Decodes an individual parameter value.
void	fillParamValues(HttpServletRequest request) Fills all class parameter values from the data provided in the current request.
String	getBroadcastMessageString() Returns the message String for the broadcast message alert of the workplace.
long	getCalendarDate(String dateString, boolean useTime) Creates the time in milliseconds from the given parameter.
static String	getCalendarJavaDateFormat(String dateFormat) Parses the JS calendar date format to the java patterns of SimpleDateFormat.
String	getCalendarLocalizedTime(long timestamp) Returns the given timestamp as String formatted in a localized pattern.
CmsObject	getCms() Returns the initialized cms object for the current user.
String	getEncoding() Returns the current workplace encoding.
String	getExplorerFileListFullUri() Returns the uri (including context path) to the explorer file list.
String	getFrameSource(String frameName, String uri) Returns the html for the frame name and source and stores this information in the workplace settings.
CmsJspActionElement	getJsp() Returns the JSP action element.
Locale	getLocale() Returns the current users locale setting.
CmsMacroResolver	getMacroResolver() Returns the current used macro resolver instance.
CmsMessages	getMessages() Returns the current used message object.
List	getMultiPartFileItems() Returns a list of FileItem instances parsed from the request, in the order that they were transmitted.
protected Map	getParameterMap() Returns the map of parameters read from the current request.
String	getResourceUri() Returns the path to the workplace static resources.
static String	getResourceUri(String resourceName) Returns the full Workplace resource path to the selected resource.
HttpSession	getSession() Returns the current user http session.
CmsWorkplaceSettings	getSettings() Returns the current users workplace settings.
static String	getSkinUri() Returns the path to the skin resources.
static String	getStyleUri(CmsJspActionElement jsp) Returns the path to the cascading stylesheets.
static String	getStyleUri(CmsJspActionElement jsp, String filename) Returns the path to the cascading stylesheets.
String	getStyleUri(String filename) Returns the path to the cascading stylesheets.
String	htmlEnd() Builds the end html of the page.
String	htmlStart(String title) Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.
protected void	initMessages() Initializes the message object.
static CmsWorkplaceSettings	initUserSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update) Updates the user settings in the given workplace settings for the current user, reading the user settings from the database if required.
protected void	initWorkplaceMembers(CmsJspActionElement jsp) Initializes this workplace class instance.
protected abstract void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
static CmsWorkplaceSettings	initWorkplaceSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update) Updates the given workplace settings, also re-initializing the state of the Workplace to the users preferences (for example setting the startup site and project).
boolean	isForwarded() Returns the forwarded flag.
boolean	isHelpEnabled() Returns true if the online help for the users current workplace language is installed.
boolean	isSubElement() Returns true if the currently processed element is an included sub element.
String	key(String keyName) Returns the localized resource string for a given message key, checking the workplace default resources and all module bundles.
String	key(String keyName, Object[] params) Returns the localized resource string for a given message key, with the provided replacement parameters.
String	key(String keyName, String defaultValue) Returns the localized resource string for the given message key, checking the workplace default resources and all module bundles.
String	nullToEmpty(String value) Returns the empty String "" if the provided value is null, otherwise just returns the provided value.
String	pageBody(int segment, String className, String parameters) Builds the html of the body.
String	pageHtml(int segment, String title) Returns the default html for a workplace page, including setting of DOCTYPE and inserting a header with the content-type.
String	pageHtmlStyle(int segment, String title, String stylesheet) Returns the default html for a workplace page, including setting of DOCTYPE and inserting a header with the content-type, allowing the selection of an individual style sheet.
String	paramsAsHidden() Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.
String	paramsAsHidden(Collection excludes) Returns all initialized parameters of the current workplace class that are not in the given exclusion list as hidden field tags that can be inserted in a form.
Map	paramsAsParameterMap() Returns all initialized parameters of the current workplace class in the form of a parameter map, i.e.
String	paramsAsRequest() Returns all initialized parameters of the current workplace class as request parameters, i.e.
protected Map	paramValues() Returns the values of all parameter methods of this workplace class instance.
String	resolveMacros(String input) Resolves the macros in the given String and replaces them by their localized keys.
void	sendCmsRedirect(String location) Sends a http redirect to the specified URI in the OpenCms VFS.
void	setForwarded(boolean forwarded) Sets the forwarded flag.
String	shortKey(String keyName) Get a localized short key value for the workplace.
protected void	switchToCurrentProject() Helper method to change back from the temporary project to the current project.
protected int	switchToTempProject() Helper method to change the current project to the temporary file project.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EXPLORER_FILELIST

public static final String FILE_EXPLORER_FILELIST

Constant for the JSP explorer filelist file.

See Also:

Constant Field Values

PATH_DIALOGS

public static final String PATH_DIALOGS

Constant for the JSP dialogs path.

See Also:

Constant Field Values

PATH_WORKPLACE

public static final String PATH_WORKPLACE

Constant for the JSP workplace path.

See Also:

Constant Field Values

DEBUG

public static final boolean DEBUG

The debug flag.

See Also:

Constant Field Values

HTML_END

public static final int HTML_END

Helper variable to deliver the html end part.

See Also:

Constant Field Values

HTML_START

public static final int HTML_START

Helper variable to deliver the html start part.

See Also:

Constant Field Values

DIALOG_PATH_COMMON

protected static final String DIALOG_PATH_COMMON

Constant for the JSP common files (e.g. error page) path.

See Also:

Constant Field Values

FILE_DIALOG_CLOSE

protected static final String FILE_DIALOG_CLOSE

Constant for the JSP common close dialog page.

See Also:

Constant Field Values

FILE_DIALOG_SCREEN_CONFIRM

protected static final String FILE_DIALOG_SCREEN_CONFIRM

Constant for the JSP common confirmation dialog.

See Also:

Constant Field Values

FILE_DIALOG_SCREEN_ERROR

protected static final String FILE_DIALOG_SCREEN_ERROR

Constant for the JSP common error dialog.

See Also:

Constant Field Values

FILE_DIALOG_SCREEN_ERRORPAGE

protected static final String FILE_DIALOG_SCREEN_ERRORPAGE

Constant for the JSP common error dialog.

See Also:

Constant Field Values

FILE_DIALOG_SCREEN_WAIT

protected static final String FILE_DIALOG_SCREEN_WAIT

Constant for the JSP common wait screen.

See Also:

Constant Field Values

FILE_REPORT_OUTPUT

protected static final String FILE_REPORT_OUTPUT

Constant for the JSP common report page.

See Also:

Constant Field Values

SESSION_WORKPLACE_CLASS

protected static final String SESSION_WORKPLACE_CLASS

Key name for the session workplace class.

See Also:

Constant Field Values

REQUEST_ATTRIBUTE_MULTIPART

protected static final String REQUEST_ATTRIBUTE_MULTIPART

Key name for the request attribute to indicate a multipart request was already parsed.

See Also:

Constant Field Values

REQUEST_ATTRIBUTE_RELOADTREE

protected static final String REQUEST_ATTRIBUTE_RELOADTREE

Key name for the request attribute to reload the folder tree view.

See Also:

Constant Field Values

TEMP_FILE_PREFIX

public static final String TEMP_FILE_PREFIX

Prefix for temporary files in the VFS.

See Also:

Constant Field Values

RFS_PATH_RESOURCES

public static final String RFS_PATH_RESOURCES

Path to exported system image folder.

See Also:

Constant Field Values

VFS_DIR_DEFAULTBODIES

public static final String VFS_DIR_DEFAULTBODIES

Directory name of content default_bodies folder.

See Also:

Constant Field Values

VFS_DIR_TEMPLATES

public static final String VFS_DIR_TEMPLATES

Directory name of content templates folder.

See Also:

Constant Field Values

VFS_PATH_SYSTEM

public static final String VFS_PATH_SYSTEM

Path to system folder.

See Also:

Constant Field Values

VFS_PATH_GALLERIES

public static final String VFS_PATH_GALLERIES

Path to the galleries.

See Also:

Constant Field Values

VFS_PATH_MODULES

public static final String VFS_PATH_MODULES

Path to modules folder.

See Also:

Constant Field Values

VFS_PATH_WORKPLACE

public static final String VFS_PATH_WORKPLACE

Path to the workplace.

See Also:

Constant Field Values

VFS_PATH_LOCALES

public static final String VFS_PATH_LOCALES

Path to locales.

See Also:

Constant Field Values

VFS_PATH_RESOURCES

public static final String VFS_PATH_RESOURCES

Path to system image folder.

See Also:

Constant Field Values

VFS_PATH_VIEWS

public static final String VFS_PATH_VIEWS

Path to workplace views.

See Also:

Constant Field Values

DEFAULT_LOCALE

public static final Locale DEFAULT_LOCALE

Parameter for the default locale.

DEFAULT_LANGUAGE

public static final String DEFAULT_LANGUAGE

Parameter for the default language.

Constructor Detail

CmsWorkplace

public CmsWorkplace(CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - the initialized JSP context

CmsWorkplace

public CmsWorkplace(PageContext context,
                    HttpServletRequest req,
                    HttpServletResponse res)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Detail

buildSelect

public static String buildSelect(String parameters,
                                 List options,
                                 List values,
                                 int selected,
                                 boolean useLineFeed)

Generates a html select box out of the provided values.

Parameters:

parameters - a string that will be inserted into the initial select tag, if null no parameters will be inserted

options - the options

values - the option values, if null the select will have no value attributes

selected - the index of the pre-selected option, if -1 no option is pre-selected

useLineFeed - if true, adds some formatting "\n" to the output String

Returns:

a String representing a html select box

getCalendarJavaDateFormat

public static String getCalendarJavaDateFormat(String dateFormat)

Parses the JS calendar date format to the java patterns of SimpleDateFormat.

Parameters:

dateFormat - the dateformat String of the JS calendar

Returns:

the parsed SimpleDateFormat pattern String

getResourceUri

public static String getResourceUri(String resourceName)

Returns the full Workplace resource path to the selected resource.

Parameters:

resourceName - the name of the resource to get the resource path for

Returns:

the full Workplace resource path to the selected resource

getSkinUri

public static String getSkinUri()

Returns the path to the skin resources.

Returns:

the path to the skin resources

getStyleUri

public static String getStyleUri(CmsJspActionElement jsp)

Returns the path to the cascading stylesheets.

Parameters:

jsp - the JSP context

Returns:

the path to the cascading stylesheets

getStyleUri

public static String getStyleUri(CmsJspActionElement jsp,
                                 String filename)

Returns the path to the cascading stylesheets.

Parameters:

jsp - the JSP context

filename - the name of the stylesheet

Returns:

the path to the cascading stylesheets

initUserSettings

public static CmsWorkplaceSettings initUserSettings(CmsObject cms,
                                                    CmsWorkplaceSettings settings,
                                                    boolean update)

Updates the user settings in the given workplace settings for the current user, reading the user settings from the database if required.

Parameters:

cms - the cms object for the current user

settings - the workplace settings to update (if null a new instance is created)

update - flag indicating if settings are only updated (user preferences)

Returns:

the current users workplace settings

See Also:

initWorkplaceSettings(CmsObject, CmsWorkplaceSettings, boolean)

initWorkplaceSettings

public static CmsWorkplaceSettings initWorkplaceSettings(CmsObject cms,
                                                         CmsWorkplaceSettings settings,
                                                         boolean update)

Updates the given workplace settings, also re-initializing the state of the Workplace to the users preferences (for example setting the startup site and project). The user settings will also be updated by calling initUserSettings(CmsObject, CmsWorkplaceSettings, boolean) before updating the workplace project, selected site etc.

Parameters:

cms - the cms object for the current user

settings - the workplace settings to update (if null a new instance is created)

update - flag indicating if settings are only updated (user preferences)

Returns:

the current users initialized workplace settings

See Also:

initUserSettings(CmsObject, CmsWorkplaceSettings, boolean)

allParamsAsHidden

public String allParamsAsHidden()

Returns all parameters of the current workplace class as hidden field tags that can be inserted in a form.

Returns:

all parameters of the current workplace class as hidden field tags that can be inserted in a html form

allParamsAsRequest

public String allParamsAsRequest()

Returns all present request parameters as String.

The String is formatted as a parameter String ("param1=val1¶m2=val2") with UTF-8 encoded values.

Returns:

all present request parameters as String

bodyEnd

public String bodyEnd()

Builds the end html of the body.

Returns:

the end html of the body

bodyStart

public String bodyStart(String className)

Builds the start html of the body.

Parameters:

className - optional class attribute to add to the body tag

Returns:

the start html of the body

bodyStart

public String bodyStart(String className,
                        String parameters)

Builds the start html of the body.

Parameters:

className - optional class attribute to add to the body tag

parameters - optional parameters to add to the body tag

Returns:

the start html of the body

buildSelect

public String buildSelect(String parameters,
                          List options,
                          List values,
                          int selected)

Generates a html select box out of the provided values.

Parameters:

parameters - a string that will be inserted into the initial select tag, if null no parameters will be inserted

options - the options

values - the option values, if null the select will have no value attributes

selected - the index of the pre-selected option, if -1 no option is pre-selected

Returns:

a formatted html String representing a html select box

button

public String button(String href,
                     String target,
                     String image,
                     String label,
                     int type)

Generates a button for the OpenCms workplace.

Parameters:

href - the href link for the button, if none is given the button will be disabled

target - the href link target for the button, if none is given the target will be same window

image - the image name for the button, skin path will be automattically added as prefix

label - the label for the text of the button

type - 0: image only (default), 1: image and text, 2: text only

Returns:

a button for the OpenCms workplace

button

public String button(String href,
                     String target,
                     String image,
                     String label,
                     int type,
                     String imagePath)

Generates a button for the OpenCms workplace.

Parameters:

href - the href link for the button, if none is given the button will be disabled

target - the href link target for the button, if none is given the target will be same window

image - the image name for the button, skin path will be automattically added as prefix

label - the label for the text of the button

type - 0: image only (default), 1: image and text, 2: text only

imagePath - the path to the image

Returns:

a button for the OpenCms workplace

buttonBar

public String buttonBar(int segment)

Returns the html for a button bar.

Parameters:

segment - the HTML segment (START / END)

Returns:

a button bar html start / end segment

buttonBar

public String buttonBar(int segment,
                        String attributes)

Returns the html for a button bar.

Parameters:

segment - the HTML segment (START / END)

attributes - optional attributes for the table tag

Returns:

a button bar html start / end segment

buttonBarHorizontalLine

public String buttonBarHorizontalLine()

Generates a horizontal button bar separator line with maximum width.

Returns:

a horizontal button bar separator line

buttonBarLabel

public String buttonBarLabel(String label)

Generates a button bar label.

Parameters:

label - the label to show

Returns:

a button bar label

buttonBarLabel

public String buttonBarLabel(String label,
                             String className)

Generates a button bar label.

Parameters:

label - the label to show

className - the css class name for the formatting

Returns:

a button bar label

buttonBarLine

public String buttonBarLine(int leftPixel,
                            int rightPixel,
                            String className)

Generates a variable button bar separator line.

Parameters:

leftPixel - the amount of pixel left to the line

rightPixel - the amount of pixel right to the line

className - the css class name for the formatting

Returns:

a variable button bar separator line

buttonBarLineSpacer

public String buttonBarLineSpacer(int pixel)

Generates a variable button bar separator line spacer.

Parameters:

pixel - the amount of pixel space

Returns:

a variable button bar separator line spacer

buttonBarSeparator

public String buttonBarSeparator(int leftPixel,
                                 int rightPixel)

Generates a button bar separator.

Parameters:

leftPixel - the amount of pixel left to the separator

rightPixel - the amount of pixel right to the separator

Returns:

a button bar separator

buttonBarSpacer

public String buttonBarSpacer(int width)

Returns the html for an invisible spacer between button bar contents like buttons, labels, etc.

Parameters:

width - the width of the invisible spacer

Returns:

the html for the invisible spacer

buttonBarStartTab

public String buttonBarStartTab(int leftPixel,
                                int rightPixel)

Generates a button bar starter tab.

Parameters:

leftPixel - the amount of pixel left to the starter

rightPixel - the amount of pixel right to the starter

Returns:

a button bar starter tab

calendarIncludes

public String calendarIncludes()

Displays a javascript calendar element with the standard "opencms" style.

Creates the HTML javascript and stylesheet includes for the head of the page.

Returns:

the necessary HTML code for the js and stylesheet includes

calendarIncludes

public String calendarIncludes(String style)

Displays a javascript calendar element.

Creates the HTML javascript and stylesheet includes for the head of the page.

Parameters:

style - the name of the used calendar style, e.g. "system", "blue"

Returns:

the necessary HTML code for the js and stylesheet includes

calendarInit

public String calendarInit(String inputFieldId,
                           String triggerButtonId,
                           String align,
                           boolean singleClick,
                           boolean weekNumbers,
                           boolean mondayFirst,
                           String dateStatusFunc)

Initializes a javascript calendar element to be shown on a page.

This method must be called at the end of a HTML page, e.g. before the closing <body> tag.

Parameters:

inputFieldId - the ID of the input field where the date is pasted to

triggerButtonId - the ID of the button which triggers the calendar

align - initial position of the calendar popup element

singleClick - if true, a single click selects a date and closes the calendar, otherwise calendar is closed by doubleclick

weekNumbers - show the week numbers in the calendar or not

mondayFirst - show monday as first day of week

dateStatusFunc - name of the function which determines if/how a date should be disabled

Returns:

the HTML code to initialize a calendar poup element

calendarInit

public String calendarInit(String inputFieldId,
                           String triggerButtonId,
                           String align,
                           boolean singleClick,
                           boolean weekNumbers,
                           boolean mondayFirst,
                           String dateStatusFunc,
                           boolean showTime)

Initializes a javascript calendar element to be shown on a page.

This method must be called at the end of a HTML page, e.g. before the closing <body> tag.

Parameters:

inputFieldId - the ID of the input field where the date is pasted to

triggerButtonId - the ID of the button which triggers the calendar

align - initial position of the calendar popup element

singleClick - if true, a single click selects a date and closes the calendar, otherwise calendar is closed by doubleclick

weekNumbers - show the week numbers in the calendar or not

mondayFirst - show monday as first day of week

dateStatusFunc - name of the function which determines if/how a date should be disabled

showTime - true if the time selector should be shown, otherwise false

Returns:

the HTML code to initialize a calendar poup element

checkLock

public void checkLock(String resource)
               throws CmsException

Checks the lock state of the resource and locks it if the autolock feature is enabled.

Parameters:

resource - the resource name which is checked

Throws:

CmsException - if reading or locking the resource fails

checkLock

public void checkLock(String resource,
                      int mode)
               throws CmsException

Checks the lock state of the resource and locks it if the autolock feature is enabled.

Parameters:

resource - the resource name which is checked

mode - flag indicating the mode (temporary or common) of a lock

Throws:

CmsException - if reading or locking the resource fails

fillParamValues

public void fillParamValues(HttpServletRequest request)

Fills all class parameter values from the data provided in the current request.

All methods that start with "setParam" are possible candidates to be automatically filled. The remaining part of the method name is converted to lower case. Then a parameter of this name is searched in the request parameters. If the parameter is found, the "setParam" method is automatically invoked by reflection with the value of the parameter.

Parameters:

request - the current JSP request

getBroadcastMessageString

public String getBroadcastMessageString()

Returns the message String for the broadcast message alert of the workplace.

Caution: returns the pure message String (not escaped) or null, if no message is pending.

Returns:

the message String for the broadcast message alert of the workplace

getCalendarDate

public long getCalendarDate(String dateString,
                            boolean useTime)
                     throws ParseException

Creates the time in milliseconds from the given parameter.

Parameters:

dateString - the String representation of the date

useTime - true if the time should be parsed, too, otherwise false

Returns:

the time in milliseconds

Throws:

ParseException - if something goes wrong

getCalendarLocalizedTime

public String getCalendarLocalizedTime(long timestamp)

Returns the given timestamp as String formatted in a localized pattern.

Parameters:

timestamp - the time to format

Returns:

the given timestamp as String formatted in a localized pattern

getCms

public CmsObject getCms()

Returns the initialized cms object for the current user.

Returns:

the initialized cms object for the current user

getEncoding

public String getEncoding()

Returns the current workplace encoding.

Returns:

the current workplace encoding

getExplorerFileListFullUri

public String getExplorerFileListFullUri()

Returns the uri (including context path) to the explorer file list.

Returns:

the uri (including context path) to the explorer file list

getFrameSource

public String getFrameSource(String frameName,
                             String uri)

Returns the html for the frame name and source and stores this information in the workplace settings.

Parameters:

frameName - the name of the frame

uri - the absolute path of the frame

Returns:

the html for the frame name and source

getJsp

public CmsJspActionElement getJsp()

Returns the JSP action element.

Returns:

the JSP action element

getLocale

public Locale getLocale()

Returns the current users locale setting.

This is a convenience method that just executes the following code: getCms().getRequestContext().getLocale().

Returns:

the current users locale setting

getMacroResolver

public CmsMacroResolver getMacroResolver()

Returns the current used macro resolver instance.

Returns:

the macro resolver

getMessages

public CmsMessages getMessages()

Returns the current used message object.

Returns:

the current used message object

getMultiPartFileItems

public List getMultiPartFileItems()

Returns a list of FileItem instances parsed from the request, in the order that they were transmitted.

This list is automatically initialized from the createParameterMapFromMultiPart(HttpServletRequest) method.

Returns:

list of FileItem instances parsed from the request, in the order that they were transmitted

getResourceUri

public String getResourceUri()

Returns the path to the workplace static resources.

Workplaces static resources are images, css files etc. These are exported during the installation of OpenCms, and are usually only read from this exported location to avoid the overhaead of accessing the database later.

Returns:

the path to the workplace static resources

getSession

public HttpSession getSession()

Returns the current user http session.

Returns:

the current user http session

getSettings

public CmsWorkplaceSettings getSettings()

Returns the current users workplace settings.

Returns:

the current users workplace settings

getStyleUri

public String getStyleUri(String filename)

Returns the path to the cascading stylesheets.

Parameters:

filename - the name of the stylesheet

Returns:

the path to the cascading stylesheets

htmlEnd

public String htmlEnd()

Builds the end html of the page.

Returns:

the end html of the page

htmlStart

public String htmlStart(String title)

Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.

Parameters:

title - the content for the title tag

Returns:

the start html of the page

isForwarded

public boolean isForwarded()

Returns the forwarded flag.

Returns:

the forwarded flag

isHelpEnabled

public boolean isHelpEnabled()

Returns true if the online help for the users current workplace language is installed.

Returns:

true if the online help for the users current workplace language is installed

isSubElement

public boolean isSubElement()

Returns true if the currently processed element is an included sub element.

Returns:

true if the currently processed element is an included sub element

key

public String key(String keyName)

Returns the localized resource string for a given message key, checking the workplace default resources and all module bundles.

If the key was not found, the return value is "??? " + keyName + " ???".

If the key starts with "help." and is not found, the value "index.html" is returned.

Parameters:

keyName - the key for the desired string

Returns:

the resource string for the given key

See Also:

CmsMessages.key(String)

key

public String key(String keyName,
                  Object[] params)

Returns the localized resource string for a given message key, with the provided replacement parameters.

If the key was found in the bundle, it will be formatted using a MessageFormat using the provided parameters.

If the key was not found in the bundle, the return value is "??? " + keyName + " ???". This will also be returned if the bundle was not properly initialized first.

Parameters:

keyName - the key for the desired string

params - the parameters to use for formatting

Returns:

the resource string for the given key

See Also:

CmsMessages.key(String)

key

public String key(String keyName,
                  String defaultValue)

Returns the localized resource string for the given message key, checking the workplace default resources and all module bundles.

If the key was not found, the provided default value is returned.

Parameters:

keyName - the key for the desired string

defaultValue - the default value in case the key does not exist in the bundle

Returns:

the resource string for the given key it it exists, or the given default if not

See Also:

CmsMessages.key(String, String)

nullToEmpty

public String nullToEmpty(String value)

Returns the empty String "" if the provided value is null, otherwise just returns the provided value.

Use this method in forms if a getParamXXX method is used, but a String (not null) is required.

Parameters:

value - the String to check

Returns:

the empty String "" if the provided value is null, otherwise just returns the provided value

pageBody

public String pageBody(int segment,
                       String className,
                       String parameters)

Builds the html of the body.

Parameters:

segment - the HTML segment (START / END)

className - optional class attribute to add to the body tag

parameters - optional parameters to add to the body tag

Returns:

the html of the body

pageHtml

public String pageHtml(int segment,
                       String title)

Returns the default html for a workplace page, including setting of DOCTYPE and inserting a header with the content-type.

Parameters:

segment - the HTML segment (START / END)

title - the title of the page, if null no title tag is inserted

Returns:

the default html for a workplace page

pageHtmlStyle

public String pageHtmlStyle(int segment,
                            String title,
                            String stylesheet)

Returns the default html for a workplace page, including setting of DOCTYPE and inserting a header with the content-type, allowing the selection of an individual style sheet.

Parameters:

segment - the HTML segment (START / END)

title - the title of the page, if null no title tag is inserted

stylesheet - the used style sheet, if null the default stylesheet 'workplace.css' is inserted

Returns:

the default html for a workplace page

paramsAsHidden

public String paramsAsHidden()

Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.

Returns:

all initialized parameters of the current workplace class as hidden field tags that can be inserted in a html form

paramsAsHidden

public String paramsAsHidden(Collection excludes)

Returns all initialized parameters of the current workplace class that are not in the given exclusion list as hidden field tags that can be inserted in a form.

Parameters:

excludes - the parameters to exclude

Returns:

all initialized parameters of the current workplace class that are not in the given exclusion list as hidden field tags that can be inserted in a form

paramsAsParameterMap

public Map paramsAsParameterMap()

Returns all initialized parameters of the current workplace class in the form of a parameter map, i.e. the values are arrays.

Returns:

all initialized parameters of the current workplace class in the form of a parameter map

paramsAsRequest

public String paramsAsRequest()

Returns all initialized parameters of the current workplace class as request parameters, i.e. in the form key1=value1&key2=value2 etc.

Returns:

all initialized parameters of the current workplace class as request parameters

resolveMacros

public String resolveMacros(String input)

Resolves the macros in the given String and replaces them by their localized keys.

The following macro contexts are available in the Workplace:

• Macros based on the current users OpenCms context (obtained from the current CmsObject).
• Localized key macros (obtained from the current CmsMessages).
• Macros from the current JSP page context (obtained by getJsp()).

Parameters:

input - the input String containing the macros

Returns:

the resolved String

See Also:

CmsMacroResolver.resolveMacros(String)

sendCmsRedirect

public void sendCmsRedirect(String location)
                     throws IOException

Sends a http redirect to the specified URI in the OpenCms VFS.

Parameters:

location - the location the response is redirected to

Throws:

IOException - in case redirection fails

setForwarded

public void setForwarded(boolean forwarded)

Sets the forwarded flag.

Parameters:

forwarded - the forwarded flag to set

shortKey

public String shortKey(String keyName)

Get a localized short key value for the workplace.

Parameters:

keyName - name of the key

Returns:

a localized short key value

addMessages

protected void addMessages(String bundleName)

Auxiliary method for initialization of messages.

Parameters:

bundleName - the bundle name to instanciate

See Also:

initMessages()

allParamValues

protected Map allParamValues()

Returns the values of all parameter methods of this workplace class instance.

Returns:

the values of all parameter methods of this workplace class instance

decodeParamValue

protected String decodeParamValue(String paramName,
                                  String paramValue)

Decodes an individual parameter value.

In special cases some parameters might require a different-from-default encoding. This is the case if the content of the parameter was encoded using the JavaScript encodeURIComponent() method on the client, which always encodes in UTF-8.

Parameters:

paramName - the name of the parameter

paramValue - the unencoded value of the parameter

Returns:

the encoded value of the parameter

getParameterMap

protected Map getParameterMap()

Returns the map of parameters read from the current request.

This method will also handle parameters from forms of type multipart/form-data.

Returns:

the map of parameters read from the current request

initMessages

protected void initMessages()

Initializes the message object.

By default the workplace messages object is used.

You SHOULD override this method for setting the bundles you really need, using the addMessages(String) method.

initWorkplaceMembers

protected void initWorkplaceMembers(CmsJspActionElement jsp)

Initializes this workplace class instance.

This method can be used in case there a workplace class was generated using Class.forName(java.lang.String) to initialize the class members.

Parameters:

jsp - the initialized JSP context

initWorkplaceRequestValues

protected abstract void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                                   HttpServletRequest request)

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Parameters:

settings - the workplace settings

request - the current request

paramValues

protected Map paramValues()

Returns the values of all parameter methods of this workplace class instance.

Returns:

the values of all parameter methods of this workplace class instance

switchToCurrentProject

protected void switchToCurrentProject()
                               throws CmsException

Helper method to change back from the temporary project to the current project.

Throws:

CmsException - if switching back fails

switchToTempProject

protected int switchToTempProject()
                           throws CmsException

Helper method to change the current project to the temporary file project.

The id of the old project is stored in a member variable to switch back.

Returns:

the id of the tempfileproject

Throws:

CmsException - if getting the tempfileproject id fails