| java.lang.Object
 org.opencms.workplace.CmsWorkplace
org.opencms.workplace.CmsFrameset
| CmsFrameset | | public class CmsFrameset extends CmsWorkplace (Code) | | Provides methods for building the main framesets of the OpenCms Workplace.
The following files use this class:
- /views/top.html
- /views/top_foot.html
- /views/top_head.html
author:
Alexander Kandzior
version:
$Revision: 1.92 $
since:
6.0.0 |
| FRAMES_LIST | | final public static List FRAMES_LIST(Code) | | The names of the supported frames in a list.
|
| JSP_WORKPLACE_URI | | final public static String JSP_WORKPLACE_URI(Code) | | Path to the JSP workplace frame loader file.
|
| PARAM_WP_FRAME | | final public static String PARAM_WP_FRAME(Code) | | The request parameter for the selection of the frame.
|
| PARAM_WP_START | | final public static String PARAM_WP_START(Code) | | The request parameter for the workplace start selection.
|
| PARAM_WP_VIEW | | final public static String PARAM_WP_VIEW(Code) | | The request parameter for the workplace view selection.
|
| CmsFrameset | | public CmsFrameset(CmsJspActionElement jsp)(Code) | | Public constructor.
Parameters:
jsp - an initialized JSP action element |
| getBroadcastMessage | | public String getBroadcastMessage()(Code) | | Returns the javascript code for the broadcast message alert in the foot of the workplace.
javascript code showing an alert box when the foot load |
| getLoginAddress | | public String getLoginAddress()(Code) | | Returns the remote ip address of the current user.
the remote ip address of the current user |
| getLoginTime | | public String getLoginTime()(Code) | | Returns the last login time of the current user in localized format.
the last login time of the current user in localized format |
| getPreferencesButton | | public String getPreferencesButton()(Code) | | Returns the html for the "preferences" button depending on the current users permissions and
the default workplace settings.
the html for the "preferences" button |
| getProjectSelect | | public String getProjectSelect(String htmlAttributes, String htmlWidth)(Code) | | Returns a html select box filled with the current users accessible projects.
Parameters:
htmlAttributes - attributes that will be inserted into the generated html
Parameters:
htmlWidth - additional style attributes containing width information a html select box filled with the current users accessible projects |
| getPublishButton | | public String getPublishButton()(Code) | | Returns the html for the "publish project" button depending on the current users permissions and the default
workplace settings.
the html for the "publish project" button |
| getPublishQueueButton | | public String getPublishQueueButton()(Code) | | Returns the html for the "publish queue" button.
the html for the "publish queue" button |
| getSiteSelect | | public String getSiteSelect(String htmlAttributes)(Code) | | Returns a html select box filled with the current users accessible sites.
Parameters:
htmlAttributes - attributes that will be inserted into the generated html a html select box filled with the current users accessible sites |
| getStartupUri | | public String getStartupUri()(Code) | | Returns the startup URI for display in the main body frame, this can
either be the user default view, or (if set) a specific startup resource.
the startup URI for display in the main body frame |
| getViewSelect | | public String getViewSelect(String htmlAttributes)(Code) | | Returns a html select box filled with the views accessible by the current user.
Parameters:
htmlAttributes - attributes that will be inserted into the generated html a html select box filled with the views accessible by the current user |
| getWorkplaceReloadUri | | public String getWorkplaceReloadUri()(Code) | | Returns the reload URI for the OpenCms workplace.
the reload URI for the OpenCms workplace |
| isReloadRequired | | public boolean isReloadRequired()(Code) | | Returns true if a reload of the main body frame is required.
This value is modified with the select options (project, site or view) in the head frame of
the Workplace. If a user changes one of these select values, the head frame is posted
"against itself". The posted values will be processed by this class, causing
the internal Workplace settings to change. After these settings have been changed,
a reload of the main body frame is required in order to update it with the new values.
A JavaScript in the Workplace head frame will be executed in this case.
true if a reload of the main body frame is required |
| isSyncEnabled | | public boolean isSyncEnabled()(Code) | | Returns true if the user has enabled synchronization.
true if the user has enabled synchronization |
| showSiteSelector | | public boolean showSiteSelector()(Code) | | Indicates if the site selector should be shown in the top frame depending on the count of accessible sites.
true if site selector should be shown, otherwise false |
| topFrameReload | | protected void topFrameReload(CmsWorkplaceSettings settings)(Code) | | Performs certain clear cache actions if the top frame is reloaded.
Parameters:
settings - the current users workplace settings |
| 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)
static void storeSettings(HttpSession session, CmsWorkplaceSettings settings)(Code)(Java Doc)
protected void switchToCurrentProject() throws CmsException(Code)(Java Doc)
protected CmsUUID switchToTempProject() throws CmsException(Code)(Java Doc)
|
|
|