Package org.opencms.workplace
Interface I_CmsDialogHandler
-
- All Superinterfaces:
I_CmsConfigurationParameterHandler
public interface I_CmsDialogHandler extends I_CmsConfigurationParameterHandler
Provides a method for selecting an individual jsp dialog.You can define the class of your own dialog handler in the OpenCms opencms-workplace.xml changing the <class> attribute of the node <dialoghandler> to another value. The class you enter must implement this interface to obtain the URI of the displayed dialog.
- Since:
- 6.0.0
-
-
Field Summary
-
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDialogHandler()
Returns the name of the handler which is used as key for the OpenCms runtime properties.java.lang.String
getDialogUri(java.lang.String resource, CmsJspActionElement jsp)
Returns the dialog URI in the OpenCms VFS to the dialog selector class.-
Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
addConfigurationParameter, getConfiguration, initConfiguration
-
-
-
-
Method Detail
-
getDialogHandler
java.lang.String getDialogHandler()
Returns the name of the handler which is used as key for the OpenCms runtime properties.Store the name of the key as a public String constant in the CmsDialogSelector class.
- Returns:
- the name of the dialog handler
-
getDialogUri
java.lang.String getDialogUri(java.lang.String resource, CmsJspActionElement jsp)
Returns the dialog URI in the OpenCms VFS to the dialog selector class.- Parameters:
resource
- the selected resourcejsp
- the CmsJspActionElement- Returns:
- the absolute path to the property dialog
-
-