org.opencms.ade.containerpage.client

类 CmsContainerpageHandler

java.lang.Object

org.opencms.gwt.client.ui.A_CmsToolbarHandler

org.opencms.ade.containerpage.client.CmsContainerpageHandler

所有已实现的接口:

I_CmsContextMenuHandler, I_CmsToolbarHandler

public class CmsContainerpageHandler
extends A_CmsToolbarHandler

The container-page handler.

从以下版本开始:

8.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.Runnable	DO_NOTHING Action which does nothing.
protected CmsContainerpageController	m_controller The container-page controller.
protected CmsContainerpageEditor	m_editor The container-page editor.

构造器概要

构造器

构造器和说明
CmsContainerpageHandler(CmsContainerpageController controller, CmsContainerpageEditor editor) Constructor.

方法概要

方法

限定符和类型	方法和说明
void	activateSelection() Activates the selection button.
void	addToFavorites(CmsListItem listItem) Adds the given list item widget to the favorite list widget.
void	addToFavorites(java.lang.String clientId) Adds the element with the given id to the favorite list.
void	addToRecent(CmsListItem listItem) Adds the given list item widget to the recent list widget.
void	addToRecent(java.lang.String clientId) Adds the element with the given id to the favorite list.
void	changeTemplateContextManually(java.lang.String cookieName, java.lang.String value) Switches the template context.
void	checkNewWidgetsAvailable(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Boolean> asyncCallback) Checks whether GWT widgets are available for all fields of a content.
protected CmsContextMenuEntry	createRawMenuEntry(CmsUUID structureId, java.lang.Runnable action) Creates a menu entry based on a structure id and action without anything else.
CmsContextMenuEntry	createSimpleContextMenuEntry(CmsUUID structureId, java.lang.String name, boolean checked, java.lang.Runnable action) Creates a context menu entry.
protected I_CmsContextMenuEntry	createTemplateContextSelectionMenuEntry(CmsUUID structureId) Creates the template context selection entry for the context menu.
protected I_CmsContextMenuEntry	createToggleEditSmallElementsMenuEntry() Creates the context menu entry for enabling or disabling editing of small elements.
void	deactivateCurrentButton() De-activates the current button.
void	deactivateMenuButton() De-activates menu button.
void	deactivateSelection() Deactivates the selection.
protected void	decorateMenuEntry(CmsContextMenuEntry entry, java.lang.String name, boolean checked) Fills in label and checkbox of a menu entry.
void	disableToolbarButtons() Deactivates all toolbar buttons.
void	editElementSettings(CmsContainerPageElementPanel elementWidget) Starts the property editor for the given container element.
void	enableFavoriteEditing(boolean enable, I_CmsDNDController dndController) Enables the favorites editing drag and drop controller.
void	enableSaveReset(boolean enable) Enables the save and reset button of the tool-bar.
void	enableToolbarButtons() Enables the toolbar buttons.
boolean	ensureLockOnResource(CmsUUID structureId) Tries to lock the given resource and returns true on success.
I_CmsToolbarButton	getActiveButton() Returns the currently active button (may be null).
java.util.Map<java.lang.String,I_CmsContextMenuCommand>	getContextMenuCommands() Returns the available context menu commands as a map by class name.
protected java.lang.String	getLockErrorMessage(CmsLockInfo lockInfo) Helper method for getting the error message for a locking error.
protected java.lang.String	getLockErrorTitle(CmsLockInfo lockInfo) Helper method for getting the error message box title for a locking error.
void	gotoSitemap() Leaves the current page and opens the site-map.
boolean	hasActiveSelection() Returns if the selection button is active.
void	hideMenu() Hides any open menu.
void	hidePageOverlay() Removes page overlay if present.
void	insertContextMenu(java.util.List<CmsContextMenuEntryBean> menuBeans, CmsUUID structureId) Inserts the context menu.
void	leavePage(com.google.gwt.user.client.Command leavingCommand) Call to leave the page.
void	leavePage(java.lang.String target) Call to leave the page.
void	loadContextMenu(CmsUUID structureId, CmsCoreData.AdeContext context) Loads the context menu entries for a given URI.
void	loadFavorites() Loads the favorite list from the server and adds it's items to the clip-board.
void	loadRecent() Loads the recent list from the server and adds it's items to the clip-board.
void	onLockFail(java.lang.String errorMessage) Should be called when locking the container page failed.
void	openEditorForElement(CmsContainerPageElementPanel element, boolean inline) Opens the edit dialog for the specified element.
void	openElementsInfo() Opens the elements info dialog.
void	openLockReportForElement(CmsContainerPageElementPanel element) Opens the lock report for the given element.
void	openModelResourceSelect(CmsContainerPageElementPanel element, java.util.List<CmsModelResourceInfo> modelResources) Opens the model select dialog for the given new element.
protected void	openPublish() Opens the publish dialog without changes check.
void	refreshResource(CmsUUID structureId) Reloads the resource edited.
void	reInitInlineEditing() Re-initializes the inline editing.
void	reloadElements(java.lang.String... elementIds) Reloads the content for the given element and all related elements.
void	removeElement(CmsContainerPageElementPanel element, CmsContainerpageController.ElementRemoveMode removeMode) Removes the given container-page element.
void	resetEditableListButtons() Shows list collector direct edit buttons (old direct edit style), if present.
void	resetPage() Resets the container-page to it's previous state.
void	saveFavoriteList(java.util.List<java.lang.String> clientIds) Saves the favorite list.
void	savePage() Saves the current state of the container-page.
void	setActiveButton(I_CmsToolbarButton button) Sets the currently active tool-bar button.
void	showElementInfo(CmsContainerPageElementPanel element) Shows resource information for a given element.
void	showPageOverlay() Shows a page overlay preventing user actions.
void	showPublishDialog() Shows the publish dialog.
void	toggleToolbar() Toggles the tool-bars visibility.
I_CmsContextMenuEntry	transformSingleEntry(CmsUUID structureId, CmsContextMenuEntryBean menuEntryBean) Creates a single context menu entry from a context menu entry bean.
void	unlockResource(CmsUUID structureId) Unlocks the resource if appropriate.
void	updateClipboard(java.util.Map<java.lang.String,CmsContainerElementData> elements) Updates the clip board elements is necessary.

从类继承的方法 org.opencms.gwt.client.ui.A_CmsToolbarHandler

transformEntries

从类继承的方法 java.lang.Object

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

字段详细资料

DO_NOTHING

public static final java.lang.Runnable DO_NOTHING

Action which does nothing.

m_controller

protected CmsContainerpageController m_controller

The container-page controller.

m_editor

protected CmsContainerpageEditor m_editor

The container-page editor.

构造器详细资料

CmsContainerpageHandler

public CmsContainerpageHandler(CmsContainerpageController controller,
                       CmsContainerpageEditor editor)

Constructor.

参数:

controller - the container-page controller

editor - the container-page editor

方法详细资料

activateSelection

public void activateSelection()

Activates the selection button.

addToFavorites

public void addToFavorites(CmsListItem listItem)

Adds the given list item widget to the favorite list widget.

参数:

listItem - the list item

addToFavorites

public void addToFavorites(java.lang.String clientId)

Adds the element with the given id to the favorite list.

参数:

clientId - the client id

addToRecent

public void addToRecent(CmsListItem listItem)

Adds the given list item widget to the recent list widget.

参数:

listItem - the list item

addToRecent

public void addToRecent(java.lang.String clientId)

Adds the element with the given id to the favorite list.

参数:

clientId - the client id

changeTemplateContextManually

public void changeTemplateContextManually(java.lang.String cookieName,
                                 java.lang.String value)

Switches the template context.

参数:

cookieName - the cookie name

value - the new template context

checkNewWidgetsAvailable

public void checkNewWidgetsAvailable(CmsUUID structureId,
                            com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Boolean> asyncCallback)

Checks whether GWT widgets are available for all fields of a content.

参数:

structureId - the structure id of the content

asyncCallback - the callback for the result

createSimpleContextMenuEntry

public CmsContextMenuEntry createSimpleContextMenuEntry(CmsUUID structureId,
                                               java.lang.String name,
                                               boolean checked,
                                               java.lang.Runnable action)

Creates a context menu entry.

参数:

structureId - structure id of the resource

name - the label

checked - true if checkbox should be displayed

action - the action to execute

返回:

the menu entry

deactivateCurrentButton

public void deactivateCurrentButton()

De-activates the current button.

deactivateMenuButton

public void deactivateMenuButton()

De-activates menu button.

deactivateSelection

public void deactivateSelection()

Deactivates the selection.

disableToolbarButtons

public void disableToolbarButtons()

Deactivates all toolbar buttons.

editElementSettings

public void editElementSettings(CmsContainerPageElementPanel elementWidget)

Starts the property editor for the given container element.

参数:

elementWidget - the container element widget for which the properties should be edited

enableFavoriteEditing

public void enableFavoriteEditing(boolean enable,
                         I_CmsDNDController dndController)

Enables the favorites editing drag and drop controller.

参数:

enable - if true favorites editing will enabled, otherwise disabled

dndController - the favorites editing drag and drop controller

enableSaveReset

public void enableSaveReset(boolean enable)

Enables the save and reset button of the tool-bar.

参数:

enable - true to enable

enableToolbarButtons

public void enableToolbarButtons()

Enables the toolbar buttons.

ensureLockOnResource

public boolean ensureLockOnResource(CmsUUID structureId)

从接口复制的说明: I_CmsContextMenuHandler

Tries to lock the given resource and returns true on success. If not successful a warning should be displayed.

参数:

structureId - the structure id of the resource to lock

返回:

true if successful

另请参阅:

I_CmsContextMenuHandler.ensureLockOnResource(org.opencms.util.CmsUUID)

getActiveButton

public I_CmsToolbarButton getActiveButton()

从接口复制的说明: I_CmsToolbarHandler

Returns the currently active button (may be null).

返回:

the currently active button

另请参阅:

I_CmsToolbarHandler.getActiveButton()

getContextMenuCommands

public java.util.Map<java.lang.String,I_CmsContextMenuCommand> getContextMenuCommands()

从接口复制的说明: I_CmsContextMenuHandler

Returns the available context menu commands as a map by class name.

返回:

the available context menu commands as a map by class name

另请参阅:

I_CmsContextMenuHandler.getContextMenuCommands()

gotoSitemap

public void gotoSitemap()

Leaves the current page and opens the site-map.

hasActiveSelection

public boolean hasActiveSelection()

Returns if the selection button is active.

返回:

true if the selection button is active

hideMenu

public void hideMenu()

Hides any open menu.

hidePageOverlay

public void hidePageOverlay()

Removes page overlay if present.

insertContextMenu

public void insertContextMenu(java.util.List<CmsContextMenuEntryBean> menuBeans,
                     CmsUUID structureId)

Inserts the context menu.

参数:

menuBeans - the menu beans from the server

structureId - the structure id of the resource for which the context menu entries should be generated

leavePage

public void leavePage(com.google.gwt.user.client.Command leavingCommand)

Call to leave the page. Will open save/leave/cancel dialog if page contains any changes.

参数:

leavingCommand - the page leaving command

leavePage

public void leavePage(java.lang.String target)

Call to leave the page. Will open save/leave/cancel dialog if page contains any changes.

参数:

target - the target

loadContextMenu

public void loadContextMenu(CmsUUID structureId,
                   CmsCoreData.AdeContext context)

Loads the context menu entries for a given URI.

参数:

structureId - the structure id of the resource for which the context menu should be loaded

context - the ade context (sitemap or containerpage)

loadFavorites

public void loadFavorites()

Loads the favorite list from the server and adds it's items to the clip-board.

loadRecent

public void loadRecent()

Loads the recent list from the server and adds it's items to the clip-board.

onLockFail

public void onLockFail(java.lang.String errorMessage)

Should be called when locking the container page failed.

参数:

errorMessage - the locking information

openEditorForElement

public void openEditorForElement(CmsContainerPageElementPanel element,
                        boolean inline)

Opens the edit dialog for the specified element.

参数:

element - the element to edit

inline - true to open the inline editor for the given element if available

openElementsInfo

public void openElementsInfo()

Opens the elements info dialog.

openLockReportForElement

public void openLockReportForElement(CmsContainerPageElementPanel element)

Opens the lock report for the given element.

参数:

element - the element

openModelResourceSelect

public void openModelResourceSelect(CmsContainerPageElementPanel element,
                           java.util.List<CmsModelResourceInfo> modelResources)

Opens the model select dialog for the given new element.

参数:

element - the element widget

modelResources - the available resource models

refreshResource

public void refreshResource(CmsUUID structureId)

从接口复制的说明: I_CmsContextMenuHandler

Reloads the resource edited.

参数:

structureId - the structure id of the resource to lock

另请参阅:

I_CmsContextMenuHandler.refreshResource(org.opencms.util.CmsUUID)

reInitInlineEditing

public void reInitInlineEditing()

Re-initializes the inline editing.

reloadElements

public void reloadElements(java.lang.String... elementIds)

Reloads the content for the given element and all related elements.

参数:

elementIds - the element id's

removeElement

public void removeElement(CmsContainerPageElementPanel element,
                 CmsContainerpageController.ElementRemoveMode removeMode)

Removes the given container-page element.

参数:

element - the element

removeMode - the element remove mode

resetEditableListButtons

public void resetEditableListButtons()

Shows list collector direct edit buttons (old direct edit style), if present.

resetPage

public void resetPage()

Resets the container-page to it's previous state.

saveFavoriteList

public void saveFavoriteList(java.util.List<java.lang.String> clientIds)

Saves the favorite list.

参数:

clientIds - the client id's of the list's elements

另请参阅:

CmsContainerpageController.saveFavoriteList(java.util.List)

savePage

public void savePage()

Saves the current state of the container-page.

setActiveButton

public void setActiveButton(I_CmsToolbarButton button)

Sets the currently active tool-bar button.

参数:

button - the button

showElementInfo

public void showElementInfo(CmsContainerPageElementPanel element)

Shows resource information for a given element.

参数:

element - the element for which to show the information

showPageOverlay

public void showPageOverlay()

Shows a page overlay preventing user actions.

showPublishDialog

public void showPublishDialog()

Shows the publish dialog.

toggleToolbar

public void toggleToolbar()

Toggles the tool-bars visibility.

transformSingleEntry

public I_CmsContextMenuEntry transformSingleEntry(CmsUUID structureId,
                                         CmsContextMenuEntryBean menuEntryBean)

从类复制的说明: A_CmsToolbarHandler

Creates a single context menu entry from a context menu entry bean.

覆盖:

transformSingleEntry 在类中 A_CmsToolbarHandler

参数:

structureId - the structure id of the resource

menuEntryBean - the context menu entry bean

返回:

the created context menu entry

另请参阅:

A_CmsToolbarHandler.transformSingleEntry(org.opencms.util.CmsUUID, org.opencms.gwt.shared.CmsContextMenuEntryBean)

unlockResource

public void unlockResource(CmsUUID structureId)

从接口复制的说明: I_CmsContextMenuHandler

Unlocks the resource if appropriate.

参数:

structureId - the structure id of the resource to lock

另请参阅:

I_CmsContextMenuHandler.unlockResource(org.opencms.util.CmsUUID)

updateClipboard

public void updateClipboard(java.util.Map<java.lang.String,CmsContainerElementData> elements)

Updates the clip board elements is necessary.

参数:

elements - the elements data

createRawMenuEntry

protected CmsContextMenuEntry createRawMenuEntry(CmsUUID structureId,
                                     java.lang.Runnable action)

Creates a menu entry based on a structure id and action without anything else.

参数:

structureId - the structure id

action - the action for the menu entry

返回:

the new menu entry

createTemplateContextSelectionMenuEntry

protected I_CmsContextMenuEntry createTemplateContextSelectionMenuEntry(CmsUUID structureId)

Creates the template context selection entry for the context menu.

参数:

structureId - the structure id of the page

返回:

the new context menu entry

createToggleEditSmallElementsMenuEntry

protected I_CmsContextMenuEntry createToggleEditSmallElementsMenuEntry()

Creates the context menu entry for enabling or disabling editing of small elements.

返回:

the created context menu entry

decorateMenuEntry

protected void decorateMenuEntry(CmsContextMenuEntry entry,
                     java.lang.String name,
                     boolean checked)

Fills in label and checkbox of a menu entry.

参数:

entry - the menu entry

name - the label

checked - true if checkbox should be shown

getLockErrorMessage

protected java.lang.String getLockErrorMessage(CmsLockInfo lockInfo)

Helper method for getting the error message for a locking error.

参数:

lockInfo - the lock information

返回:

the error message

getLockErrorTitle

protected java.lang.String getLockErrorTitle(CmsLockInfo lockInfo)

Helper method for getting the error message box title for a locking error.

参数:

lockInfo - the lock information

返回:

the error message box title

openPublish

protected void openPublish()

Opens the publish dialog without changes check.