org.opencms.ui.dialogs.embedded

Class CmsDataViewParams

java.lang.Object

org.opencms.ui.dialogs.embedded.CmsDataViewParams

public class CmsDataViewParams
extends java.lang.Object

Class representing the configuration passed to the Vaadin data view dialog by the client.

Constructor Summary

Constructors

Constructor and Description
CmsDataViewParams(java.net.URI uri) Creates a new instance by parsing the query string of the given URI.

Method Summary

Modifier and Type	Method and Description
I_CmsDataView	createViewInstance(CmsObject cms, java.util.Locale locale) Creates the data view instance.
boolean	isMultiSelect() Return true if the list should have multi-selection enabled.
java.lang.String	prepareCallbackScript(java.util.List<I_CmsDataViewItem> result) Creates the script which calls the callback with the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsDataViewParams

public CmsDataViewParams(java.net.URI uri)

Creates a new instance by parsing the query string of the given URI.

Parameters:

uri - the URI from which to read the configuration

Method Detail

createViewInstance

public I_CmsDataView createViewInstance(CmsObject cms,
                                        java.util.Locale locale)

Creates the data view instance.

Parameters:

cms - the CMS context

locale - the locale

Returns:

the new data view instance

isMultiSelect

public boolean isMultiSelect()

Return true if the list should have multi-selection enabled.

Returns:

true if multi-selection should be enabled

prepareCallbackScript

public java.lang.String prepareCallbackScript(java.util.List<I_CmsDataViewItem> result)

Creates the script which calls the callback with the result.

Parameters:

result - the list of result data items

Returns:

the script to call the callback