Package org.opencms.ui

Class A_CmsDialogContext

java.lang.Object

org.opencms.ui.A_CmsDialogContext

All Implemented Interfaces:

I_CmsDialogContext

Direct Known Subclasses:

CmsFileTableDialogContext, CmsToolBar.ToolbarContext

public abstract class A_CmsDialogContext
extends Object
implements I_CmsDialogContext

Abstract dialog context.

Nested Class Summary

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

I_CmsDialogContext.ContextType

Field Summary

Fields

Modifier and Type	Field	Description
protected com.vaadin.ui.Window	m_window	The window used to display the dialog.

Fields inherited from interface org.opencms.ui.I_CmsDialogContext

ATTR_SITEMAP_CONFIG_RESOURCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	A_CmsDialogContext(String appId, I_CmsDialogContext.ContextType contextType, List<CmsResource> resources)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	closeWindow()	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.
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.
List<CmsResource>	getResources()	Gets the list of resources for which the dialog should be opened.
com.vaadin.ui.Window	getWindow()	Returns the window.
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	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 style)	Called to start up the dialog with the given main widget and title string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.ui.I_CmsDialogContext

focus, getAllStructureIdsInView, getParameters, updateUserInfo

Field Details

m_window

protected com.vaadin.ui.Window m_window

The window used to display the dialog.

Constructor Details

A_CmsDialogContext

protected A_CmsDialogContext(String appId,
 I_CmsDialogContext.ContextType contextType,
 List<CmsResource> resources)

Constructor.

Parameters:

appId - the app id

contextType - the context type, to be used for visibility evaluation

resources - the list of resources

Method Details

closeWindow

protected void closeWindow()

Closes the dialog window.

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)

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()

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()

getWindow

public com.vaadin.ui.Window getWindow()

Returns the window.

Returns:

the window

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()

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 style)

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

style - the preferred width for the dialog

See Also:

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