Package org.opencms.ade.editprovider.client

Class CmsDirectEditButtons

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.google.gwt.user.client.ui.FlowPanel

org.opencms.gwt.client.ui.A_CmsDirectEditButtons

org.opencms.ade.editprovider.client.CmsDirectEditButtons

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, I_CmsElementToolbarContext, I_CmsContentEditorHandler, I_CmsUniqueActiveItem

public class CmsDirectEditButtons
extends A_CmsDirectEditButtons
implements I_CmsContentEditorHandler

Direct edit buttons for the Toolbar direct edit provider.

Since:

8.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Field Summary

Fields inherited from class org.opencms.gwt.client.ui.A_CmsDirectEditButtons

m_delete, m_edit, m_editableData, m_expiredOverlay, m_highlighting, m_markerTag, m_new, m_parentResourceId, m_position

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Fields inherited from interface org.opencms.gwt.client.I_CmsElementToolbarContext

ELEMENT_OPTION_BAR_CSS_CLASS

Constructor Summary

Constructors

Constructor	Description
CmsDirectEditButtons(com.google.gwt.dom.client.Element editable, String parentId)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	deleteElement()	Delete the editable element from page and VFS.
protected Map<Integer,CmsPushButton>	getAdditionalButtons()	Returns a map of additional buttons in a map, with the button position as key (buttons will be ordered by their position).
protected String	getUploadButtonTitle(String uploadFolder)	Gets the upload button title.
protected void	onClickDelete()	This method should be executed when the "delete" direct edit button is clicked.
protected void	onClickEdit()	This method should be executed when the "edit" direct edit button is clicked.
protected void	onClickNew(boolean askCreateMode)	This method should be executed when the "new" direct edit button is clicked.
void	onClose(String sitePath, org.opencms.util.CmsUUID structureId, boolean isNew, boolean hasChangedSettings, boolean usedPublishDialog)	Executed by the XML content editor dialog on close.
protected void	openEditDialog(boolean isNew, String mode)	Opens the content editor.
void	setPosition(CmsPositionBean position, CmsPositionBean buttonsPosition, com.google.gwt.dom.client.Element containerElement)	Sets the position.

Methods inherited from class org.opencms.gwt.client.ui.A_CmsDirectEditButtons

activateToolbarContext, addHighlightingAndBar, addMouseOutHandler, addMouseOverHandler, createInfoButton, deactivateToolbarContext, getInfoContext, getMarkerTag, highlightElement, isValid, onClickUpload, onDeactivate, removeFromParent, removeHighlighting, removeHighlightingAndBar, setPosition, updateExpiredOverlayPosition

Methods inherited from class com.google.gwt.user.client.ui.FlowPanel

add, clear, insert, insert

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

CmsDirectEditButtons

public CmsDirectEditButtons(com.google.gwt.dom.client.Element editable,
 String parentId)

Creates a new instance.

Parameters:

editable - the editable element

parentId - the parent id

Method Details

onClose

public void onClose(String sitePath,
 org.opencms.util.CmsUUID structureId,
 boolean isNew,
 boolean hasChangedSettings,
 boolean usedPublishDialog)

Description copied from interface: I_CmsContentEditorHandler

Executed by the XML content editor dialog on close.

Specified by:

onClose in interface I_CmsContentEditorHandler

Parameters:

sitePath - the sitepath of the edited resource

structureId - the structure id of the edited resource

isNew - true if the resource was newly created

hasChangedSettings - true in case container page element settings where changed during edit

usedPublishDialog - true if the editor was closed by using the publish button

See Also:

• org.opencms.gwt.client.ui.contenteditor.I_CmsContentEditorHandler#onClose(java.lang.String, org.opencms.util.CmsUUID, boolean, boolean)

setPosition

public void setPosition(CmsPositionBean position,
 CmsPositionBean buttonsPosition,
 com.google.gwt.dom.client.Element containerElement)

Sets the position. Make sure the widget is attached to the DOM.

Parameters:

position - the absolute position

buttonsPosition - the corrected position for the buttons

containerElement - the parent container element

deleteElement

protected void deleteElement()

Delete the editable element from page and VFS.

getAdditionalButtons

protected Map<Integer,CmsPushButton> getAdditionalButtons()

Description copied from class: A_CmsDirectEditButtons

Returns a map of additional buttons in a map, with the button position as key (buttons will be ordered by their position).

Overrides:

getAdditionalButtons in class A_CmsDirectEditButtons

Returns:

the map of additional buttons

See Also:

• A_CmsDirectEditButtons.getAdditionalButtons()

getUploadButtonTitle

protected String getUploadButtonTitle(String uploadFolder)

Description copied from class: A_CmsDirectEditButtons

Gets the upload button title.

Specified by:

getUploadButtonTitle in class A_CmsDirectEditButtons

Parameters:

uploadFolder - the upload folder

Returns:

the upload button title

See Also:

• A_CmsDirectEditButtons.getUploadButtonTitle(java.lang.String)

onClickDelete

protected void onClickDelete()

Description copied from class: A_CmsDirectEditButtons

This method should be executed when the "delete" direct edit button is clicked.

Specified by:

onClickDelete in class A_CmsDirectEditButtons

See Also:

• A_CmsDirectEditButtons.onClickDelete()

onClickEdit

protected void onClickEdit()

Description copied from class: A_CmsDirectEditButtons

This method should be executed when the "edit" direct edit button is clicked.

Specified by:

onClickEdit in class A_CmsDirectEditButtons

See Also:

• A_CmsDirectEditButtons.onClickEdit()

onClickNew

protected void onClickNew(boolean askCreateMode)

Description copied from class: A_CmsDirectEditButtons

This method should be executed when the "new" direct edit button is clicked.

Specified by:

onClickNew in class A_CmsDirectEditButtons

Parameters:

askCreateMode - true if the user should be asked for the 'content create mode'

See Also:

• A_CmsDirectEditButtons.onClickNew(boolean)

openEditDialog

protected void openEditDialog(boolean isNew,
 String mode)

Opens the content editor.

Parameters:

isNew - true to create and edit a new resource

mode - the content creation mode