| java.lang.Object
 org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
All known Subclasses: org.opencms.workplace.administration.CmsAdminFrameset, org.opencms.workplace.administration.CmsAdminMenu, org.opencms.workplace.CmsDialog,
| CmsToolDialog | | public class CmsToolDialog extends CmsWorkplace (Code) | | Helper class that encapsulates all the code for the "new"
style of the administration dialogs.
author:
Michael Moossen
version:
$Revision: 1.39 $
since:
6.0.0 |
| Field Summary | |
| final public static String | PARAM_BASE
Request parameter name for the base tool path in the navegation, should be a parent tool of path. | | final public static String | PARAM_PATH
Request parameter name for the tool path, should be an accesible tool under the given root. | | final public static String | PARAM_ROOT
Request parameter name for the root tool path. | | final public static String | PARAM_STYLE
Request parameter name for the style type. | | final public static String | STYLE_NEW
Request parameter value for the 'new' dialog style. |
| PARAM_BASE | | final public static String PARAM_BASE(Code) | | Request parameter name for the base tool path in the navegation, should be a parent tool of path.
|
| PARAM_PATH | | final public static String PARAM_PATH(Code) | | Request parameter name for the tool path, should be an accesible tool under the given root.
|
| PARAM_ROOT | | final public static String PARAM_ROOT(Code) | | Request parameter name for the root tool path.
|
| PARAM_STYLE | | final public static String PARAM_STYLE(Code) | | Request parameter name for the style type.
|
| STYLE_NEW | | final public static String STYLE_NEW(Code) | | Request parameter value for the 'new' dialog style.
|
| CmsToolDialog | | public CmsToolDialog(CmsJspActionElement jsp)(Code) | | Default Constructor.
Parameters:
jsp - the jsp action element |
| dialogScriptSubmit | | public String dialogScriptSubmit()(Code) | | Builds the standard javascript for submitting the dialog.
Should only be used by the
CmsDialog.dialogScriptSubmit method.
the standard javascript for submitting the dialog |
| getAdminTool | | public CmsTool getAdminTool()(Code) | | Returns the admin tool.
the admin tool |
| getCurrentToolPath | | public String getCurrentToolPath()(Code) | | Returns the current tool path.
the current tool path |
| getParamBase | | public String getParamBase()(Code) | | Returns the value for the base parameter.
the value for the base parameter |
| getParamPath | | public String getParamPath()(Code) | | Returns the path parameter value.
the path parameter value |
| getParamRoot | | public String getParamRoot()(Code) | | Returns the root parameter value.
the root parameter value |
| getParamStyle | | public String getParamStyle()(Code) | | Returns the style parameter value.
the style parameter value |
| getParentPath | | public String getParentPath()(Code) | | Returns the path to the parent tool.
tha path to the parent tool |
| getToolManager | | public CmsToolManager getToolManager()(Code) | | Returns the tool manager.
the tool manager |
| iconsBlockArea | | public String iconsBlockArea(int segment, String headline)(Code) | | Builds an block area for icons.
Parameters:
segment - the HTML segment (START / END)
Parameters:
headline - the headline String for the block block area start / end segment
See Also: CmsDialog.dialogBlock(intStringboolean) |
| iconsBlockAreaEnd | | public String iconsBlockAreaEnd()(Code) | | Builds the end HTML for a block area with border in the dialog content area.
block area end segment
See Also: CmsDialog.dialogBlockEnd |
| iconsBlockAreaStart | | public String iconsBlockAreaStart(String headline)(Code) | | Builds the start HTML for a block area with border and optional subheadline in the dialog content area.
Parameters:
headline - the headline String for the block block area start segment
See Also: CmsDialog.dialogBlockStart(String) |
| setParamBase | | public void setParamBase(String paramBase)(Code) | | Sets the value of the base parameter.
Parameters:
paramBase - the value of the base parameter to set |
| setParamPath | | public void setParamPath(String paramPath)(Code) | | Sets the path parameter value.
Parameters:
paramPath - the path parameter value to set |
| setParamRoot | | public void setParamRoot(String paramRoot)(Code) | | Sets the root parameter value.
Parameters:
paramRoot - the root parameter value to set |
| setParamStyle | | public void setParamStyle(String paramStyle)(Code) | | Sets the style parameter value.
Parameters:
paramStyle - the style parameter value to set |
| useNewStyle | | public boolean useNewStyle()(Code) | | Tests if we are working with the new administration dialog style.
The default is the new style, this param is not intented for external use.
true if using the new style |
| Methods inherited from org.opencms.workplace.CmsWorkplace | protected void addMessages(CmsMessages messages)(Code)(Java Doc)
protected void addMessages(String bundleName)(Code)(Java Doc)
protected Map allParamValues()(Code)(Java Doc)
public String allParamsAsHidden()(Code)(Java Doc)
public String allParamsAsRequest()(Code)(Java Doc)
public String bodyEnd()(Code)(Java Doc)
public String bodyStart(String className)(Code)(Java Doc)
public String bodyStart(String className, String parameters)(Code)(Java Doc)
public static String buildSelect(String parameters, List options, List values, int selected, boolean useLineFeed)(Code)(Java Doc)
public String buildSelect(String parameters, List options, List values, int selected)(Code)(Java Doc)
public String button(String href, String target, String image, String label, int type)(Code)(Java Doc)
public String button(String href, String target, String image, String label, int type, String imagePath)(Code)(Java Doc)
public String buttonBar(int segment)(Code)(Java Doc)
public String buttonBar(int segment, String attributes)(Code)(Java Doc)
public String buttonBarHorizontalLine()(Code)(Java Doc)
public String buttonBarLabel(String label)(Code)(Java Doc)
public String buttonBarLabel(String label, String className)(Code)(Java Doc)
public String buttonBarLine(int leftPixel, int rightPixel, String className)(Code)(Java Doc)
public String buttonBarLineSpacer(int pixel)(Code)(Java Doc)
public String buttonBarSeparator(int leftPixel, int rightPixel)(Code)(Java Doc)
public String buttonBarSpacer(int width)(Code)(Java Doc)
public String buttonBarStartTab(int leftPixel, int rightPixel)(Code)(Java Doc)
public void checkLock(String resource) throws CmsException(Code)(Java Doc)
public void checkLock(String resource, CmsLockType type) throws CmsException(Code)(Java Doc)
protected void checkRole() throws CmsRoleViolationException(Code)(Java Doc)
protected String decodeParamValue(String paramName, String paramValue)(Code)(Java Doc)
public void fillParamValues(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
public void fillParamValues(HttpServletRequest request)(Code)(Java Doc)
public String getBroadcastMessageString()(Code)(Java Doc)
public CmsObject getCms()(Code)(Java Doc)
public String getEncoding()(Code)(Java Doc)
public String getExplorerFileListFullUri()(Code)(Java Doc)
public String getFrameSource(String frameName, String uri)(Code)(Java Doc)
public CmsJspActionElement getJsp()(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public CmsMacroResolver getMacroResolver()(Code)(Java Doc)
public CmsMessages getMessages()(Code)(Java Doc)
public List getMultiPartFileItems()(Code)(Java Doc)
protected Map getParameterMap()(Code)(Java Doc)
public static String getResourceUri(String resourceName)(Code)(Java Doc)
public String getResourceUri()(Code)(Java Doc)
public HttpSession getSession()(Code)(Java Doc)
public CmsWorkplaceSettings getSettings()(Code)(Java Doc)
public static String getSkinUri()(Code)(Java Doc)
public static String getStyleUri(CmsJspActionElement jsp)(Code)(Java Doc)
public static String getStyleUri(CmsJspActionElement jsp, String filename)(Code)(Java Doc)
public String getStyleUri(String filename)(Code)(Java Doc)
public static String getTemporaryFileName(String resourceName)(Code)(Java Doc)
public String htmlEnd()(Code)(Java Doc)
public String htmlStart(String title)(Code)(Java Doc)
protected void initMessages()(Code)(Java Doc)
public boolean initSettings(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
protected void initTimeWarp(CmsUserSettings settings, HttpSession session)(Code)(Java Doc)
public static CmsWorkplaceSettings initUserSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update)(Code)(Java Doc)
protected void initWorkplaceMembers(CmsJspActionElement jsp)(Code)(Java Doc)
abstract protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
public static synchronized CmsWorkplaceSettings initWorkplaceSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update)(Code)(Java Doc)
public boolean isForwarded()(Code)(Java Doc)
public boolean isHelpEnabled()(Code)(Java Doc)
public boolean isSubElement()(Code)(Java Doc)
public static boolean isTemporaryFile(CmsResource resource)(Code)(Java Doc)
public static boolean isTemporaryFileName(String resourceName)(Code)(Java Doc)
public String key(String keyName)(Code)(Java Doc)
public String key(String keyName, Object[] params)(Code)(Java Doc)
public String keyDefault(String keyName, String defaultValue)(Code)(Java Doc)
public String nullToEmpty(String value)(Code)(Java Doc)
public String pageBody(int segment, String className, String parameters)(Code)(Java Doc)
public String pageHtml(int segment, String title)(Code)(Java Doc)
public String pageHtmlStyle(int segment, String title, String stylesheet)(Code)(Java Doc)
protected Map paramValues()(Code)(Java Doc)
public String paramsAsHidden()(Code)(Java Doc)
public String paramsAsHidden(Collection excludes)(Code)(Java Doc)
public Map paramsAsParameterMap()(Code)(Java Doc)
public String paramsAsRequest()(Code)(Java Doc)
public String resolveMacros(String input)(Code)(Java Doc)
public void sendCmsRedirect(String location) throws IOException(Code)(Java Doc)
public void sendForward(String location, Map params) throws IOException, ServletException(Code)(Java Doc)
public void setForwarded(boolean forwarded)(Code)(Java Doc)
public String shortKey(String keyName)(Code)(Java Doc)
protected void switchToCurrentProject() throws CmsException(Code)(Java Doc)
protected CmsUUID switchToTempProject() throws CmsException(Code)(Java Doc)
|
|
|