org.opencms.gwt.client.util

Class CmsEmbeddedDialogHandler

java.lang.Object

org.opencms.gwt.client.util.CmsEmbeddedDialogHandler

public class CmsEmbeddedDialogHandler
extends java.lang.Object

Handler for embedded VAADIN dialogs.

Constructor Summary

Constructors

Constructor and Description
CmsEmbeddedDialogHandler() Constructor.
CmsEmbeddedDialogHandler(I_CmsActionHandler handler) Constructor.

Method Summary

Modifier and Type	Method and Description
void	finish(java.lang.String resources) Called on dialog close.
boolean	hasDialogFrame() Returns if the dialog iframe is attached.
void	leavePage(java.lang.String targetUri) Navigates to the given URI.
void	onSiteOrProjectChange(java.lang.String sitePath, java.lang.String serverLink) Called when site and or project have been changed.
void	openDialog(java.lang.String dialogId, java.lang.String contextType, java.util.List<org.opencms.util.CmsUUID> resources) Opens the dialog with the given id.
void	openDialog(java.lang.String dialogId, java.lang.String contextType, java.util.List<org.opencms.util.CmsUUID> resources, java.util.Map<java.lang.String,java.lang.String> rawParams) Opens the dialog with the given id.
protected java.util.List<org.opencms.util.CmsUUID>	parseResources(java.lang.String resources) Parses the resources string.
void	reload() Reloads the current page.
void	setOnCloseCommand(com.google.gwt.user.client.Command onCloseCommand) Sets the on close command.
void	setPrinciple(java.lang.String principle) Calls the principle select handler and closes the dialog frame.
void	setPrincipleSelectHandler(I_CmsPrincipalSelectHandler principleHandler) Sets the principle select handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsEmbeddedDialogHandler

public CmsEmbeddedDialogHandler()

Constructor.

CmsEmbeddedDialogHandler

public CmsEmbeddedDialogHandler(I_CmsActionHandler handler)

Constructor.

Parameters:

handler - the context handler

Method Detail

finish

public void finish(java.lang.String resources)

Called on dialog close.

Parameters:

resources - the resource ids to update as a ';' separated string.

hasDialogFrame

public boolean hasDialogFrame()

Returns if the dialog iframe is attached.

Returns:

true if the dialog iframe is attached

leavePage

public void leavePage(java.lang.String targetUri)

Navigates to the given URI.

Parameters:

targetUri - the target URI

onSiteOrProjectChange

public void onSiteOrProjectChange(java.lang.String sitePath,
                                  java.lang.String serverLink)

Called when site and or project have been changed.

Parameters:

sitePath - the site path to the resource to display

serverLink - the server link to the resource to display

openDialog

public void openDialog(java.lang.String dialogId,
                       java.lang.String contextType,
                       java.util.List<org.opencms.util.CmsUUID> resources)

Opens the dialog with the given id.

Parameters:

dialogId - the dialog id

contextType - the context type, used to check the action visibility

resources - the resource to handle

openDialog

public void openDialog(java.lang.String dialogId,
                       java.lang.String contextType,
                       java.util.List<org.opencms.util.CmsUUID> resources,
                       java.util.Map<java.lang.String,java.lang.String> rawParams)

Opens the dialog with the given id.

Parameters:

dialogId - the dialog id

contextType - the context type, used to check the action visibility

resources - the resource to handle

rawParams - additional set of parameters to append to the query string (will not be escaped, therefore 'raw')

reload

public void reload()

Reloads the current page.

setOnCloseCommand

public void setOnCloseCommand(com.google.gwt.user.client.Command onCloseCommand)

Sets the on close command.

Parameters:

onCloseCommand - the on close command

setPrinciple

public void setPrinciple(java.lang.String principle)

Calls the principle select handler and closes the dialog frame.

Parameters:

principle - the principle to select

setPrincipleSelectHandler

public void setPrincipleSelectHandler(I_CmsPrincipalSelectHandler principleHandler)

Sets the principle select handler.

Parameters:

principleHandler - the principle select handler

parseResources

protected java.util.List<org.opencms.util.CmsUUID> parseResources(java.lang.String resources)

Parses the resources string.

Parameters:

resources - the resources

Returns:

the list of resource ids