public class CmsPrincipalWidget extends A_CmsWidget implements I_CmsADEWidget
A_CmsWidget.CmsDummyWidgetDialog
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CONFIGURATION_FLAGS
Configuration parameter to set the flags of the principals to display, optional.
|
HELP_POSTFIX, LABEL_PREFIX
Constructor and Description |
---|
CmsPrincipalWidget()
Creates a new principals selection widget.
|
CmsPrincipalWidget(java.lang.Integer flags)
Creates a new principals selection widget with the parameters to configure the popup window behaviour.
|
CmsPrincipalWidget(java.lang.String configuration)
Creates a new principals selection widget with the given configuration.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getButtonJs(java.lang.String id,
java.lang.String form)
Returns the needed java script for the search button.
|
java.lang.String |
getConfiguration()
Returns the configuration string.
|
java.lang.String |
getConfiguration(CmsObject cms,
A_CmsXmlContentValue schemaType,
CmsMessages messages,
CmsResource resource,
java.util.Locale contentLocale)
Returns the configuration string for the ADE content editor widget.
|
java.util.List<java.lang.String> |
getCssResourceLinks(CmsObject cms)
Returns a list of CSS resources required by the widget.
|
I_CmsXmlContentHandler.DisplayType |
getDefaultDisplayType()
Returns the default display type of this widget.
|
java.lang.String |
getDialogIncludes(CmsObject cms,
I_CmsWidgetDialog widgetDialog)
Generates the necessary JavaScript inclusion code for this widget.
|
java.lang.String |
getDialogWidget(CmsObject cms,
I_CmsWidgetDialog widgetDialog,
I_CmsWidgetParameter param)
Generates the widget HTML for the provided widget parameter.
|
java.lang.Integer |
getFlags()
Returns the flags, or
null if all. |
java.lang.String |
getInitCall()
Returns the java script initialization call.
|
java.util.List<java.lang.String> |
getJavaScriptResourceLinks(CmsObject cms)
Returns a list of java script resources required by the widget.
|
java.lang.String |
getWidgetName()
Returns the class name of the widget.
|
boolean |
isInternal()
Returns if this is an internal widget.
|
I_CmsWidget |
newInstance()
Creates a duplicate of this widget instance.
|
void |
setConfiguration(java.lang.String configuration)
Sets the configuration of this widget.
|
equals, getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, isCompactViewEnabled, setEditorValue
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled, setEditorValue
public static final java.lang.String CONFIGURATION_FLAGS
public CmsPrincipalWidget()
public CmsPrincipalWidget(java.lang.Integer flags)
flags
- the group flags to restrict the group selection, can be null
public CmsPrincipalWidget(java.lang.String configuration)
configuration
- the configuration to usepublic java.lang.String getButtonJs(java.lang.String id, java.lang.String form)
id
- the id of the widget to generate the search button forform
- the id of the form where to which the widget belongspublic java.lang.String getConfiguration()
A_CmsWidget
getConfiguration
in interface I_CmsWidget
getConfiguration
in class A_CmsWidget
A_CmsWidget.getConfiguration()
public java.lang.String getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
I_CmsADEWidget
getConfiguration
in interface I_CmsADEWidget
cms
- the OpenCms contextschemaType
- the schema typemessages
- the messagesresource
- the edited resourcecontentLocale
- the content localeI_CmsADEWidget.getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)
public java.util.List<java.lang.String> getCssResourceLinks(CmsObject cms)
I_CmsADEWidget
getCssResourceLinks
in interface I_CmsADEWidget
cms
- the current OpenCms contextI_CmsADEWidget.getCssResourceLinks(org.opencms.file.CmsObject)
public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()
I_CmsADEWidget
getDefaultDisplayType
in interface I_CmsADEWidget
I_CmsADEWidget.getDefaultDisplayType()
public java.lang.String getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
I_CmsWidget
getDialogIncludes
in interface I_CmsWidget
getDialogIncludes
in class A_CmsWidget
cms
- the current users OpenCms contextwidgetDialog
- the dialog where the widget is used onI_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
public java.lang.String getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
I_CmsWidget
getDialogWidget
in interface I_CmsWidget
cms
- an initialized instance of a CmsObjectwidgetDialog
- the dialog where the widget is used onparam
- the widget parameter to generate the widget forI_CmsWidget.getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
public java.lang.Integer getFlags()
null
if all.null
if allpublic java.lang.String getInitCall()
I_CmsADEWidget
getInitCall
in interface I_CmsADEWidget
I_CmsADEWidget.getInitCall()
public java.util.List<java.lang.String> getJavaScriptResourceLinks(CmsObject cms)
I_CmsADEWidget
getJavaScriptResourceLinks
in interface I_CmsADEWidget
cms
- the current OpenCms contextI_CmsADEWidget.getJavaScriptResourceLinks(org.opencms.file.CmsObject)
public java.lang.String getWidgetName()
I_CmsADEWidget
getWidgetName
in interface I_CmsADEWidget
I_CmsADEWidget.getWidgetName()
public boolean isInternal()
I_CmsADEWidget
Only widgets belonging to the OpenCms core should be marked as internal.
isInternal
in interface I_CmsADEWidget
true
if this is an internal widgetI_CmsADEWidget.isInternal()
public I_CmsWidget newInstance()
I_CmsWidget
newInstance
in interface I_CmsWidget
I_CmsWidget.newInstance()
public void setConfiguration(java.lang.String configuration)
I_CmsWidget
This can be used to enable / disable certain widget features that should not always be available, or to pass specific initialization information to the widget. It depends on the widget implementation on how this information is used.
setConfiguration
in interface I_CmsWidget
setConfiguration
in class A_CmsWidget
configuration
- the configuration to setA_CmsWidget.setConfiguration(java.lang.String)