Package org.opencms.ui.components.extensions

Class CmsPropertyDialogExtension

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

org.opencms.ui.components.extensions.CmsPropertyDialogExtension

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Extension, com.vaadin.shared.communication.ServerRpc, com.vaadin.shared.Connector, Serializable, I_CmsPropertyServerRpc

public class CmsPropertyDialogExtension
extends com.vaadin.server.AbstractExtension
implements I_CmsPropertyServerRpc

Extension used for the GWT-based property dialog called from the workplace. This keeps track of the list of resources which were visible when the property dialog was opened, allowing the user to navigate through the list with prev/next buttons.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Constructor Summary

Constructors

Constructor	Description
CmsPropertyDialogExtension(com.vaadin.ui.UI ui, I_CmsUpdateListener<String> updateListener)	Creates a new instance and binds it to a UI instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEdit(CmsUUID id)	Checks if the user can edit the resource with the given id.
void	editProperties(CmsUUID structureId, List<CmsUUID> allIds, boolean editName)	Open property editor for the resource with the given structure id.
void	editPropertiesForNewResource(CmsNewResourceBuilder builder)	Opens the property dialog for a resource to be created with the 'New' dialog.
void	onClose(long delayMillis)	Disposes of the extension, and tells the server which resources have changed.
void	removeExtension()	Removes the extension on the server side.
void	requestNextFile(int offset)	Requests the id of the next file.
void	savePropertiesForNewResource(String data)	Saves the properties for a new resource.

Methods inherited from class com.vaadin.server.AbstractExtension

extend, getParent, getSupportedParentType, remove, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, attach, beforeClientResponse, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getState, getState, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Details

CmsPropertyDialogExtension

public CmsPropertyDialogExtension(com.vaadin.ui.UI ui,
 I_CmsUpdateListener<String> updateListener)

Creates a new instance and binds it to a UI instance.

Parameters:

ui - the UI to bind this extension to

updateListener - the update listener

Method Details

editProperties

public void editProperties(CmsUUID structureId,
 List<CmsUUID> allIds,
 boolean editName)

Open property editor for the resource with the given structure id.

Parameters:

structureId - the structure id of a resource

allIds - structure ids of resources for the prev/next navigation

editName - controls whether the file name should be editable

editPropertiesForNewResource

public void editPropertiesForNewResource(CmsNewResourceBuilder builder)

Opens the property dialog for a resource to be created with the 'New' dialog.

Parameters:

builder - the resource builder used by the 'New' dialog to create the resource

onClose

public void onClose(long delayMillis)

Description copied from interface: I_CmsPropertyServerRpc

Disposes of the extension, and tells the server which resources have changed.

Specified by:

onClose in interface I_CmsPropertyServerRpc

Parameters:

delayMillis - time to delay the RPC (for allowing short background operations to finish)

See Also:

• I_CmsPropertyServerRpc.onClose(long)

removeExtension

public void removeExtension()

Description copied from interface: I_CmsPropertyServerRpc

Removes the extension on the server side.

Specified by:

removeExtension in interface I_CmsPropertyServerRpc

See Also:

• I_CmsPropertyServerRpc.removeExtension()

requestNextFile

public void requestNextFile(int offset)

Description copied from interface: I_CmsPropertyServerRpc

Requests the id of the next file.

Specified by:

requestNextFile in interface I_CmsPropertyServerRpc

Parameters:

offset - should be +1 for the next file, or -1 for the previous file

See Also:

• I_CmsPropertyServerRpc.requestNextFile(int)

savePropertiesForNewResource

public void savePropertiesForNewResource(String data)

Description copied from interface: I_CmsPropertyServerRpc

Saves the properties for a new resource.

Specified by:

savePropertiesForNewResource in interface I_CmsPropertyServerRpc

Parameters:

data - the serialized property data (CmsPropertyChangeSet)

See Also:

• I_CmsPropertyServerRpc.savePropertiesForNewResource(java.lang.String)

canEdit

protected boolean canEdit(CmsUUID id)

Checks if the user can edit the resource with the given id.

Parameters:

id - a structure id

Returns:

true if the user can edit the file