org.opencms.ui

Interface I_CmsDialogContext

All Known Subinterfaces:

I_CmsDialogContextWithAdeContext

All Known Implementing Classes:

A_CmsDialogContext, CmsEmbeddedDialogContext, CmsExplorerDialogContext, CmsFileTableDialogContext, CmsListManager.DialogContext, CmsSitemapTreeController.DialogContext, CmsToolBar.ToolbarContext

public interface I_CmsDialogContext

Context for dialogs opened from the context menu.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	I_CmsDialogContext.ContextType The available context types.

Method Summary

Modifier and Type	Method and Description
void	error(java.lang.Throwable error) Signals an error which occurred in the dialog.
void	finish(CmsProject project, java.lang.String siteRoot) Signals that the dialog has finished.
void	finish(java.util.Collection<CmsUUID> result) Signals that the dialog has finished.
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.
CmsObject	getCms() Gets the CMS context to be used for dialog operations.
I_CmsDialogContext.ContextType	getContextType() Returns the context type.
java.util.List<CmsResource>	getResources() Gets the list of resources for which the dialog should be opened.
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	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.

Method Detail

error

void error(java.lang.Throwable error)

Signals an error which occurred in the dialog.

Parameters:

error - the error which occcurred

finish

void finish(CmsProject project,
            java.lang.String siteRoot)

Signals that the dialog has finished.

Call when current project and or site have been changed.

Parameters:

project - changed project

siteRoot - changed site root

finish

void finish(java.util.Collection<CmsUUID> result)

Signals that the dialog has finished.

Parameters:

result - the list of structure ids of changed resources

focus

void focus(CmsUUID structureId)

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

Parameters:

structureId - the structure id of a resource

getAllStructureIdsInView

java.util.List<CmsUUID> getAllStructureIdsInView()

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

Returns:

the structure ids of all the resources in the current view

getAppId

java.lang.String getAppId()

Returns the app id.

Returns:

the app id

getCms

CmsObject getCms()

Gets the CMS context to be used for dialog operations.

Returns:

the CMS context

getContextType

I_CmsDialogContext.ContextType getContextType()

Returns the context type.

May be used for visibility evaluation.

Returns:

the context type

getResources

java.util.List<CmsResource> getResources()

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

Returns:

the list of resources

navigateTo

void navigateTo(java.lang.String appId)

Navigates to the given app.

Parameters:

appId - the app id

onViewChange

void onViewChange()

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

reload

void reload()

Reloads the UI.

setWindow

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

Sets the current window.

Parameters:

window - the current dialog window

start

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.

Parameters:

title - the title to display

dialog - the dialog main widget

start

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.

Parameters:

title - the title to display

dialog - the dialog main widget

width - the preferred width for the dialog

updateUserInfo

void updateUserInfo()

Called when the user info was changed.