Package org.opencms.widgets

Class CmsAddFormatterWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

org.opencms.widgets.CmsSelectWidget

org.opencms.widgets.A_CmsFormatterWidget

org.opencms.widgets.CmsAddFormatterWidget

All Implemented Interfaces:

I_CmsADEWidget, I_CmsWidget

public class CmsAddFormatterWidget
extends A_CmsFormatterWidget

Widget used to select a formatter to add.

Please note that this widget assumes the resource being edited is a sitemap configuration, and will not work correctly in a different context.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsFormatterWidget

A_CmsFormatterWidget.FormatterSelectComparator

Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

Field Summary

Fields inherited from class org.opencms.widgets.A_CmsFormatterWidget

LOG

Fields inherited from class org.opencms.widgets.A_CmsSelectWidget

CONFIGURATION_HEIGHT

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsAddFormatterWidget()	Default constructor.
CmsAddFormatterWidget(java.lang.String config)	Constructor with a configuration parameter.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getCssResourceLinks(CmsObject cms)	Returns a list of CSS resources required by the widget.
protected java.util.List<CmsSelectWidgetOption>	getFormatterOptions(CmsObject cms, CmsADEConfigData config, java.lang.String rootPath, boolean allRemoved)	Gets the options corresponding to external (non-schema) formatters.
protected static java.util.List<CmsSelectWidgetOption>	getFormatterOptionsStatic(CmsObject cms, CmsADEConfigData config, java.lang.String rootPath, boolean allRemoved)	Gets the options corresponding to external (non-schema) formatters.
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.
protected java.util.Set<java.lang.String>	getSelectedInFile(CmsConfigurationReader reader, CmsXmlContent content)	Gets the values which have already been selected in the edited resource on the VFS.
static java.util.List<java.lang.String>	getSelectOptionValues(CmsObject cms, java.lang.String rootPath, boolean allRemoved)	Returns all values that can be selected in the widget.
protected java.util.List<CmsSelectWidgetOption>	getTypeOptions(CmsObject cms, CmsADEConfigData adeConfig, boolean allRemoved)	Gets the options corresponding to the schemas which define formatters.
protected static java.util.List<CmsSelectWidgetOption>	getTypeOptionsStatic(CmsObject cms, CmsADEConfigData adeConfig, boolean allRemoved)	Gets the options corresponding to the schemas which define formatters.
boolean	isInternal()	Returns if this is an internal widget.
I_CmsWidget	newInstance()	Creates a duplicate of this widget instance.

Methods inherited from class org.opencms.widgets.A_CmsFormatterWidget

getConfiguration, getWidgetName, getWidgetOptionForFormatter, getWidgetOptionForType, parseSelectOptions, parseSelectOptions

Methods inherited from class org.opencms.widgets.CmsSelectWidget

getDialogWidget, getWidgetStringValue

Methods inherited from class org.opencms.widgets.A_CmsSelectWidget

addSelectOption, getConfiguration, getDefaultDisplayType, getHeight, getResourcePath, getSelectedValue, getSelectedValues, getSelectOptions, setConfiguration, setSelectOptions

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, hashCode, isCompactViewEnabled, setEditorValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.widgets.I_CmsWidget

getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, isCompactViewEnabled, setEditorValue

Constructor Detail

CmsAddFormatterWidget

public CmsAddFormatterWidget()

Default constructor.

CmsAddFormatterWidget

public CmsAddFormatterWidget(java.lang.String config)

Constructor with a configuration parameter.

Parameters:

config - the configuration string

Method Detail

getSelectOptionValues

public static java.util.List<java.lang.String> getSelectOptionValues(CmsObject cms,
                                                                     java.lang.String rootPath,
                                                                     boolean allRemoved)

Returns all values that can be selected in the widget.

Parameters:

cms - the current CMS object

rootPath - the root path to the currently edited xml file (sitemap config)

allRemoved - flag, indicating if all inheritedly available formatters should be disabled

Returns:

all values that can be selected in the widget.

getFormatterOptionsStatic

protected static java.util.List<CmsSelectWidgetOption> getFormatterOptionsStatic(CmsObject cms,
                                                                                 CmsADEConfigData config,
                                                                                 java.lang.String rootPath,
                                                                                 boolean allRemoved)

Gets the options corresponding to external (non-schema) formatters.

Parameters:

cms - the CMS context

config - the ADE configuration

rootPath - the root path of the edited file

allRemoved - flag, indicating if all inheritedly available formatters should be disabled

Returns:

the select widget options for the external formatters

getTypeOptionsStatic

protected static java.util.List<CmsSelectWidgetOption> getTypeOptionsStatic(CmsObject cms,
                                                                            CmsADEConfigData adeConfig,
                                                                            boolean allRemoved)

Gets the options corresponding to the schemas which define formatters.

Parameters:

cms - the current CMS context

adeConfig - the ADE configuration

allRemoved - flag, indicating if all inheritedly available formatters should be disabled

Returns:

the select widget options for the content types with formatters in the schema

getCssResourceLinks

public java.util.List<java.lang.String> getCssResourceLinks(CmsObject cms)

Description copied from class: A_CmsSelectWidget

Returns a list of CSS resources required by the widget.

Specified by:

getCssResourceLinks in interface I_CmsADEWidget

Overrides:

getCssResourceLinks in class A_CmsSelectWidget

Parameters:

cms - the current OpenCms context

Returns:

the required CSS resource links

See Also:

I_CmsADEWidget.getCssResourceLinks(org.opencms.file.CmsObject)

getInitCall

public java.lang.String getInitCall()

Description copied from class: A_CmsSelectWidget

Returns the java script initialization call.

Specified by:

getInitCall in interface I_CmsADEWidget

Overrides:

getInitCall in class A_CmsSelectWidget

Returns:

the java script initialization call

See Also:

I_CmsADEWidget.getInitCall()

getJavaScriptResourceLinks

public java.util.List<java.lang.String> getJavaScriptResourceLinks(CmsObject cms)

Description copied from class: A_CmsSelectWidget

Returns a list of java script resources required by the widget.

Specified by:

getJavaScriptResourceLinks in interface I_CmsADEWidget

Overrides:

getJavaScriptResourceLinks in class A_CmsSelectWidget

Parameters:

cms - the current OpenCms context

Returns:

the required java script resource links

See Also:

I_CmsADEWidget.getJavaScriptResourceLinks(org.opencms.file.CmsObject)

isInternal

public boolean isInternal()

Description copied from class: A_CmsSelectWidget

Returns if this is an internal widget.

Only widgets belonging to the OpenCms core should be marked as internal.

Specified by:

isInternal in interface I_CmsADEWidget

Overrides:

isInternal in class A_CmsSelectWidget

Returns:

true if this is an internal widget

See Also:

I_CmsADEWidget.isInternal()

newInstance

public I_CmsWidget newInstance()

Description copied from interface: I_CmsWidget

Creates a duplicate of this widget instance.

Specified by:

newInstance in interface I_CmsWidget

Overrides:

newInstance in class CmsSelectWidget

Returns:

a duplicate of this widget instance

See Also:

CmsSelectWidget.newInstance()

getFormatterOptions

protected java.util.List<CmsSelectWidgetOption> getFormatterOptions(CmsObject cms,
                                                                    CmsADEConfigData config,
                                                                    java.lang.String rootPath,
                                                                    boolean allRemoved)

Description copied from class: A_CmsFormatterWidget

Gets the options corresponding to external (non-schema) formatters.

Specified by:

getFormatterOptions in class A_CmsFormatterWidget

Parameters:

cms - the CMS context

config - the ADE configuration

rootPath - the root path of the edited file

allRemoved - flag, indicating if all inheritedly available formatters should be disabled

Returns:

the select widget options for the external formatters

See Also:

A_CmsFormatterWidget.getFormatterOptions(org.opencms.file.CmsObject, org.opencms.ade.configuration.CmsADEConfigData, java.lang.String, boolean)

getSelectedInFile

protected java.util.Set<java.lang.String> getSelectedInFile(CmsConfigurationReader reader,
                                                            CmsXmlContent content)

Description copied from class: A_CmsFormatterWidget

Gets the values which have already been selected in the edited resource on the VFS.

Specified by:

getSelectedInFile in class A_CmsFormatterWidget

Parameters:

reader - a sitemap configuration reader

content - the unmarshalled content

Returns:

the set of values which have already been selected

See Also:

A_CmsFormatterWidget.getSelectedInFile(org.opencms.ade.configuration.CmsConfigurationReader, org.opencms.xml.content.CmsXmlContent)

getTypeOptions

protected java.util.List<CmsSelectWidgetOption> getTypeOptions(CmsObject cms,
                                                               CmsADEConfigData adeConfig,
                                                               boolean allRemoved)

Description copied from class: A_CmsFormatterWidget

Gets the options corresponding to the schemas which define formatters.

Specified by:

getTypeOptions in class A_CmsFormatterWidget

Parameters:

cms - the current CMS context

adeConfig - the ADE configuration

allRemoved - flag, indicating if all inheritedly available formatters should be disabled

Returns:

the select widget options for the content types with formatters in the schema

See Also:

A_CmsFormatterWidget.getTypeOptions(org.opencms.file.CmsObject, org.opencms.ade.configuration.CmsADEConfigData, boolean)