Package org.opencms.ui.dialogs
Class CmsEmbeddedDialogContext
- java.lang.Object
-
- org.opencms.ui.dialogs.CmsEmbeddedDialogContext
-
- All Implemented Interfaces:
I_CmsDialogContext
public class CmsEmbeddedDialogContext extends java.lang.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(java.lang.String appId, CmsEmbeddedDialogExtension extension, I_CmsDialogContext.ContextType contextType, java.util.List<CmsResource> resources, java.util.Map<java.lang.String,java.lang.String> parameters)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
closeWindow(boolean keepFrame)
Closes the dialog window.void
error(java.lang.Throwable error)
Signals an error which occurred in the dialog.void
finish(java.util.Collection<CmsUUID> result)
Signals that the dialog has finished.void
finish(CmsProject project, java.lang.String siteRoot)
Signals that the dialog has finished.void
finish(CmsExtendedSiteSelector.SiteSelectorOption option)
Opens the location from the site selector option.void
finishWithString(java.lang.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.java.util.List<CmsUUID>
getAllStructureIdsInView()
Gets a list of structure ids of all visible resources, not just the ones selected for the dialog.java.lang.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.java.util.Map<java.lang.String,java.lang.String>
getParameters()
Gets additional parameters.java.util.List<CmsResource>
getResources()
Gets the list of resources for which the dialog should be opened.void
leavePage(java.lang.String uri)
Leaves page by navigating to given URI.void
navigateTo(java.lang.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(java.lang.String principalName)
Sets the principal.void
setWindow(com.vaadin.ui.Window window)
Sets the current window.void
start(java.lang.String title, com.vaadin.ui.Component dialog)
Called to start up the dialog with the given main widget and title string.void
start(java.lang.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.
-
-
-
Constructor Detail
-
CmsEmbeddedDialogContext
public CmsEmbeddedDialogContext(java.lang.String appId, CmsEmbeddedDialogExtension extension, I_CmsDialogContext.ContextType contextType, java.util.List<CmsResource> resources, java.util.Map<java.lang.String,java.lang.String> parameters)
Constructor.- Parameters:
appId
- the app idextension
- the extension used to communicate with the clientcontextType
- the context typeresources
- the resourcesparameters
- the additional parameters
-
-
Method Detail
-
closeWindow
public void closeWindow(boolean keepFrame)
Closes the dialog window.- Parameters:
keepFrame
-true
to keep the embedded iFrame.
-
error
public void error(java.lang.Throwable error)
Description copied from interface:I_CmsDialogContext
Signals an error which occurred in the dialog.- Specified by:
error
in interfaceI_CmsDialogContext
- Parameters:
error
- the error which occcurred- See Also:
I_CmsDialogContext.error(java.lang.Throwable)
-
finish
public void finish(CmsProject project, java.lang.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 interfaceI_CmsDialogContext
- Parameters:
project
- changed projectsiteRoot
- changed site root- See Also:
I_CmsDialogContext.finish(org.opencms.file.CmsProject, java.lang.String)
-
finish
public void finish(java.util.Collection<CmsUUID> result)
Description copied from interface:I_CmsDialogContext
Signals that the dialog has finished.- Specified by:
finish
in interfaceI_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(java.lang.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 interfaceI_CmsDialogContext
- Parameters:
structureId
- the structure id of a resource- See Also:
I_CmsDialogContext.focus(org.opencms.util.CmsUUID)
-
getAllStructureIdsInView
public java.util.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 interfaceI_CmsDialogContext
- Returns:
- the structure ids of all the resources in the current view
- See Also:
I_CmsDialogContext.getAllStructureIdsInView()
-
getAppId
public java.lang.String getAppId()
Description copied from interface:I_CmsDialogContext
Returns the app id.- Specified by:
getAppId
in interfaceI_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 interfaceI_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 interfaceI_CmsDialogContext
- Returns:
- the context type
- See Also:
I_CmsDialogContext.getContextType()
-
getParameters
public java.util.Map<java.lang.String,java.lang.String> getParameters()
Description copied from interface:I_CmsDialogContext
Gets additional parameters.- Specified by:
getParameters
in interfaceI_CmsDialogContext
- Returns:
- the map of additional parameters
- See Also:
I_CmsDialogContext.getParameters()
-
getResources
public java.util.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 interfaceI_CmsDialogContext
- Returns:
- the list of resources
- See Also:
I_CmsDialogContext.getResources()
-
leavePage
public void leavePage(java.lang.String uri)
Leaves page by navigating to given URI.- Parameters:
uri
- the URI to navigate to
-
navigateTo
public void navigateTo(java.lang.String appId)
Description copied from interface:I_CmsDialogContext
Navigates to the given app.- Specified by:
navigateTo
in interfaceI_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 interfaceI_CmsDialogContext
- See Also:
I_CmsDialogContext.onViewChange()
-
reload
public void reload()
Description copied from interface:I_CmsDialogContext
Reloads the UI.- Specified by:
reload
in interfaceI_CmsDialogContext
- See Also:
I_CmsDialogContext.reload()
-
selectString
public void selectString(java.lang.String principalName)
Sets the principal.- Parameters:
principalName
- the principal name
-
setWindow
public void setWindow(com.vaadin.ui.Window window)
Description copied from interface:I_CmsDialogContext
Sets the current window.- Specified by:
setWindow
in interfaceI_CmsDialogContext
- Parameters:
window
- the current dialog window- See Also:
I_CmsDialogContext.setWindow(com.vaadin.ui.Window)
-
start
public void start(java.lang.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 interfaceI_CmsDialogContext
- Parameters:
title
- the title to displaydialog
- the dialog main widget- See Also:
I_CmsDialogContext.start(java.lang.String, com.vaadin.ui.Component)
-
start
public void start(java.lang.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 interfaceI_CmsDialogContext
- Parameters:
title
- the title to displaydialog
- the dialog main widgetwidth
- 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 interfaceI_CmsDialogContext
- See Also:
I_CmsDialogContext.updateUserInfo()
-
getClientRPC
protected I_CmsEmbeddedDialogClientRPC getClientRPC()
Returns the client RPC.- Returns:
- the client RPC
-
-