Package org.opencms.ui.dialogs

Class CmsEmbeddedDialogContext

java.lang.Object

org.opencms.ui.dialogs.CmsEmbeddedDialogContext

All Implemented Interfaces:

I_CmsDialogContext

public class CmsEmbeddedDialogContext
extends Object
implements I_CmsDialogContext

Context for dialogs embedded into plain GWT modules.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.ui.I_CmsDialogContext

I_CmsDialogContext.ContextType

Field Summary

Fields inherited from interface org.opencms.ui.I_CmsDialogContext

ATTR_SITEMAP_CONFIG_RESOURCE

Constructor Summary

Constructors

Constructor	Description
CmsEmbeddedDialogContext(String appId, CmsEmbeddedDialogExtension extension, I_CmsDialogContext.ContextType contextType, List<CmsResource> resources, Map<String,String> parameters)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	closeWindow(boolean keepFrame)	Closes the dialog window.
void	error(Throwable error)	Signals an error which occurred in the dialog.
void	finish(Collection<CmsUUID> result)	Signals that the dialog has finished.
void	finish(CmsProject project, String siteRoot)	Signals that the dialog has finished.
void	finish(CmsExtendedSiteSelector.SiteSelectorOption option)	Opens the location from the site selector option.
void	finishWithString(String str)	Finishes the dialog and returns an arbitrary string to the opener.
void	focus(CmsUUID structureId)	Tell the system that the resource with the given id should be shown somehow.
List<CmsUUID>	getAllStructureIdsInView()	Gets a list of structure ids of all visible resources, not just the ones selected for the dialog.
String	getAppId()	Returns the app id.
protected I_CmsEmbeddedDialogClientRPC	getClientRPC()	Returns the client RPC.
CmsObject	getCms()	Gets the CMS context to be used for dialog operations.
I_CmsDialogContext.ContextType	getContextType()	Returns the context type.
Map<String,String>	getParameters()	Gets additional parameters.
List<CmsResource>	getResources()	Gets the list of resources for which the dialog should be opened.
void	leavePage(String uri)	Leaves page by navigating to given URI.
void	navigateTo(String appId)	Navigates to the given app.
void	onViewChange()	Call when the dialog view has changed to re-center the dialog window.
void	reload()	Reloads the UI.
void	selectString(String principalName)	Sets the principal.
void	sendNotification(boolean error, String notification)	Send a notification to the client to display.
void	setWindow(com.vaadin.ui.Window window)	Sets the current window.
void	start(String title, com.vaadin.ui.Component dialog)	Called to start up the dialog with the given main widget and title string.
void	start(String title, com.vaadin.ui.Component dialog, CmsBasicDialog.DialogWidth width)	Called to start up the dialog with the given main widget and title string.
void	updateUserInfo()	Called when the user info was changed.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsEmbeddedDialogContext

public CmsEmbeddedDialogContext(String appId,
 CmsEmbeddedDialogExtension extension,
 I_CmsDialogContext.ContextType contextType,
 List<CmsResource> resources,
 Map<String,String> parameters)

Constructor.

Parameters:

appId - the app id

extension - the extension used to communicate with the client

contextType - the context type

resources - the resources

parameters - the additional parameters

Method Details

closeWindow

public void closeWindow(boolean keepFrame)

Closes the dialog window.

Parameters:

keepFrame - true to keep the embedded iFrame.

error

public void error(Throwable error)

Description copied from interface: I_CmsDialogContext

Signals an error which occurred in the dialog.

Specified by:

error in interface I_CmsDialogContext

Parameters:

error - the error which occcurred

See Also:

• I_CmsDialogContext.error(java.lang.Throwable)

finish

public void finish(CmsProject project,
 String siteRoot)

Description copied from interface: I_CmsDialogContext

Signals that the dialog has finished.

Call when current project and or site have been changed.

Specified by:

finish in interface I_CmsDialogContext

Parameters:

project - changed project

siteRoot - changed site root

See Also:

• I_CmsDialogContext.finish(org.opencms.file.CmsProject, java.lang.String)

finish

public void finish(Collection<CmsUUID> result)

Description copied from interface: I_CmsDialogContext

Signals that the dialog has finished.

Specified by:

finish in interface I_CmsDialogContext

Parameters:

result - the list of structure ids of changed resources

See Also:

• I_CmsDialogContext.finish(java.util.Collection)

finish

public void finish(CmsExtendedSiteSelector.SiteSelectorOption option)

Opens the location from the site selector option.

Parameters:

option - the site selector option

finishWithString

public void finishWithString(String str)

Finishes the dialog and returns an arbitrary string to the opener.

Parameters:

str - the string to pass to the opener

focus

public void focus(CmsUUID structureId)

Description copied from interface: I_CmsDialogContext

Tell the system that the resource with the given id should be shown somehow.

Specified by:

focus in interface I_CmsDialogContext

Parameters:

structureId - the structure id of a resource

See Also:

• I_CmsDialogContext.focus(org.opencms.util.CmsUUID)

getAllStructureIdsInView

public List<CmsUUID> getAllStructureIdsInView()

Description copied from interface: I_CmsDialogContext

Gets a list of structure ids of all visible resources, not just the ones selected for the dialog.

Specified by:

getAllStructureIdsInView in interface I_CmsDialogContext

Returns:

the structure ids of all the resources in the current view

See Also:

• I_CmsDialogContext.getAllStructureIdsInView()

getAppId

public String getAppId()

Description copied from interface: I_CmsDialogContext

Returns the app id.

Specified by:

getAppId in interface I_CmsDialogContext

Returns:

the app id

See Also:

• I_CmsDialogContext.getAppId()

getCms

public CmsObject getCms()

Description copied from interface: I_CmsDialogContext

Gets the CMS context to be used for dialog operations.

Specified by:

getCms in interface I_CmsDialogContext

Returns:

the CMS context

See Also:

• I_CmsDialogContext.getCms()

getContextType

public I_CmsDialogContext.ContextType getContextType()

Description copied from interface: I_CmsDialogContext

Returns the context type.

May be used for visibility evaluation.

Specified by:

getContextType in interface I_CmsDialogContext

Returns:

the context type

See Also:

• I_CmsDialogContext.getContextType()

getParameters

public Map<String,String> getParameters()

Description copied from interface: I_CmsDialogContext

Gets additional parameters.

Specified by:

getParameters in interface I_CmsDialogContext

Returns:

the map of additional parameters

See Also:

• I_CmsDialogContext.getParameters()

getResources

public List<CmsResource> getResources()

Description copied from interface: I_CmsDialogContext

Gets the list of resources for which the dialog should be opened.

Specified by:

getResources in interface I_CmsDialogContext

Returns:

the list of resources

See Also:

• I_CmsDialogContext.getResources()

leavePage

public void leavePage(String uri)

Leaves page by navigating to given URI.

Parameters:

uri - the URI to navigate to

navigateTo

public void navigateTo(String appId)

Description copied from interface: I_CmsDialogContext

Navigates to the given app.

Specified by:

navigateTo in interface I_CmsDialogContext

Parameters:

appId - the app id

See Also:

• I_CmsDialogContext.navigateTo(java.lang.String)

onViewChange

public void onViewChange()

Description copied from interface: I_CmsDialogContext

Call when the dialog view has changed to re-center the dialog window.

Specified by:

onViewChange in interface I_CmsDialogContext

See Also:

• I_CmsDialogContext.onViewChange()

reload

public void reload()

Description copied from interface: I_CmsDialogContext

Reloads the UI.

Specified by:

reload in interface I_CmsDialogContext

See Also:

• I_CmsDialogContext.reload()

selectString

public void selectString(String principalName)

Sets the principal.

Parameters:

principalName - the principal name

sendNotification

public void sendNotification(boolean error,
 String notification)

Send a notification to the client to display.

Parameters:

error - true if this is an error notification

notification - the notification HTML

setWindow

public void setWindow(com.vaadin.ui.Window window)

Description copied from interface: I_CmsDialogContext

Sets the current window.

Specified by:

setWindow in interface I_CmsDialogContext

Parameters:

window - the current dialog window

See Also:

• I_CmsDialogContext.setWindow(com.vaadin.ui.Window)

start

public void start(String title,
 com.vaadin.ui.Component dialog)

Description copied from interface: I_CmsDialogContext

Called to start up the dialog with the given main widget and title string.

Specified by:

start in interface I_CmsDialogContext

Parameters:

title - the title to display

dialog - the dialog main widget

See Also:

• I_CmsDialogContext.start(java.lang.String, com.vaadin.ui.Component)

start

public void start(String title,
 com.vaadin.ui.Component dialog,
 CmsBasicDialog.DialogWidth width)

Description copied from interface: I_CmsDialogContext

Called to start up the dialog with the given main widget and title string.

Specified by:

start in interface I_CmsDialogContext

Parameters:

title - the title to display

dialog - the dialog main widget

width - the preferred width for the dialog

See Also:

• I_CmsDialogContext.start(java.lang.String, com.vaadin.ui.Component, org.opencms.ui.components.CmsBasicDialog.DialogWidth)

updateUserInfo

public void updateUserInfo()

Description copied from interface: I_CmsDialogContext

Called when the user info was changed.

Specified by:

updateUserInfo in interface I_CmsDialogContext

See Also:

• I_CmsDialogContext.updateUserInfo()

getClientRPC

protected I_CmsEmbeddedDialogClientRPC getClientRPC()

Returns the client RPC.

Returns:

the client RPC