Package org.opencms.ui.components

Class CmsFileTableDialogContext

java.lang.Object

org.opencms.ui.A_CmsDialogContext

org.opencms.ui.components.CmsFileTableDialogContext

All Implemented Interfaces:

I_CmsDialogContext, I_CmsEditPropertyContext

Direct Known Subclasses:

CmsExplorerDialogContext, CmsListManager.DialogContext

public class CmsFileTableDialogContext
extends A_CmsDialogContext
implements I_CmsEditPropertyContext

The file table 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 CmsFileTable	m_fileTable	The file table instance.

Fields inherited from class org.opencms.ui.A_CmsDialogContext

m_window

Fields inherited from interface org.opencms.ui.I_CmsDialogContext

ATTR_SITEMAP_CONFIG_RESOURCE

Constructor Summary

Constructors

Constructor	Description
CmsFileTableDialogContext(String appId, I_CmsDialogContext.ContextType contextType, CmsFileTable fileTable, List<CmsResource> resources)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	editProperty(Object propertyId)	Start the editing process.
void	finish(Collection<CmsUUID> ids)	Signals that the dialog has finished.
void	finish(CmsProject project, String siteRoot)	Signals that the dialog has finished.
void	focus(CmsUUID cmsUUID)	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.
boolean	isPropertyEditable(Object propertyId)	Checks whether the given property is editable.
void	setEditableProperties(Collection<CmsResourceTableProperty> editableProperties)	Sets the in line editable properties.
void	updateUserInfo()	Called when the user info was changed.

Methods inherited from class org.opencms.ui.A_CmsDialogContext

closeWindow, error, getAppId, getCms, getContextType, getResources, getWindow, navigateTo, onViewChange, reload, setWindow, start, start

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

getParameters

Field Details

m_fileTable

protected CmsFileTable m_fileTable

The file table instance.

Constructor Details

CmsFileTableDialogContext

public CmsFileTableDialogContext(String appId,
 I_CmsDialogContext.ContextType contextType,
 CmsFileTable fileTable,
 List<CmsResource> resources)

Creates a new instance.

Parameters:

appId - the app id

contextType - the context type

fileTable - the file table instance

resources - the list of selected resources

Method Details

editProperty

public void editProperty(Object propertyId)

Description copied from interface: I_CmsEditPropertyContext

Start the editing process.

Specified by:

editProperty in interface I_CmsEditPropertyContext

Parameters:

propertyId - the property to edit

See Also:

• I_CmsEditPropertyContext.editProperty(java.lang.Object)

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

Overrides:

finish in class A_CmsDialogContext

Parameters:

project - changed project

siteRoot - changed site root

See Also:

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

finish

public void finish(Collection<CmsUUID> ids)

Description copied from interface: I_CmsDialogContext

Signals that the dialog has finished.

Specified by:

finish in interface I_CmsDialogContext

Overrides:

finish in class A_CmsDialogContext

Parameters:

ids - the list of structure ids of changed resources

See Also:

• I_CmsDialogContext.finish(java.util.Collection)

focus

public void focus(CmsUUID cmsUUID)

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:

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

isPropertyEditable

public boolean isPropertyEditable(Object propertyId)

Description copied from interface: I_CmsEditPropertyContext

Checks whether the given property is editable.

Specified by:

isPropertyEditable in interface I_CmsEditPropertyContext

Parameters:

propertyId - the property id

Returns:

true if the given property is editable

See Also:

• I_CmsEditPropertyContext.isPropertyEditable(java.lang.Object)

setEditableProperties

public void setEditableProperties(Collection<CmsResourceTableProperty> editableProperties)

Sets the in line editable properties.

Parameters:

editableProperties - the in line editable properties

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