org.opencms.widgets

类 CmsCalendarWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.CmsCalendarWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

public class CmsCalendarWidget
extends A_CmsWidget
implements I_CmsADEWidget

Provides a DHTML calendar widget, for use on a widget dialog.

从以下版本开始:

6.0.0

嵌套类概要

从类继承的嵌套类/接口 org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

字段概要

从类继承的字段 org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
CmsCalendarWidget() Creates a new calendar widget.
CmsCalendarWidget(java.lang.String configuration) Creates a new calendar widget with the given configuration.

方法概要

方法

限定符和类型	方法和说明
static java.lang.String	calendarIncludes(java.util.Locale locale) Creates the HTML JavaScript and stylesheet includes required by the calendar for the head of the page.
static java.lang.String	calendarIncludes(java.util.Locale locale, java.lang.String style) Creates the HTML JavaScript and stylesheet includes required by the calendar for the head of the page.
static java.lang.String	calendarInit(CmsMessages messages, java.lang.String inputFieldId, java.lang.String triggerButtonId, java.lang.String align, boolean singleClick, boolean weekNumbers, boolean mondayFirst, java.lang.String dateStatusFunc, boolean showTime) Generates the HTML to initialize the JavaScript calendar element on the end of a page.
static long	getCalendarDate(CmsMessages messages, java.lang.String dateString, boolean useTime) Creates the time in milliseconds from the given parameter.
static java.lang.String	getCalendarJavaDateFormat(java.lang.String dateFormat) Parses the JavaScript calendar date format to the java patterns of SimpleDateFormat.
static java.lang.String	getCalendarLocalizedTime(java.util.Locale locale, CmsMessages messages, long timestamp) Returns the given timestamp as String formatted in a localized pattern.
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.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.
java.lang.String	getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.
boolean	isInternal() Returns if this is an internal widget.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.
void	setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

从类继承的方法 org.opencms.widgets.A_CmsWidget

equals, getConfiguration, getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, hashCode, isCompactViewEnabled, setConfiguration

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.widgets.I_CmsWidget

getConfiguration, getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, isCompactViewEnabled, setConfiguration

构造器详细资料

CmsCalendarWidget

public CmsCalendarWidget()

Creates a new calendar widget.

CmsCalendarWidget

public CmsCalendarWidget(java.lang.String configuration)

Creates a new calendar widget with the given configuration.

参数:

configuration - the configuration to use

方法详细资料

calendarIncludes

public static java.lang.String calendarIncludes(java.util.Locale locale)

Creates the HTML JavaScript and stylesheet includes required by the calendar for the head of the page.

The default "opencms" style is used.

参数:

locale - the locale to use for the calendar

返回:

the necessary HTML code for the js and stylesheet includes

另请参阅:

calendarIncludes(Locale, String)

calendarIncludes

public static java.lang.String calendarIncludes(java.util.Locale locale,
                                java.lang.String style)

Creates the HTML JavaScript and stylesheet includes required by the calendar for the head of the page.

参数:

locale - the locale to use for the calendar

style - the name of the used calendar style, e.g. "system", "blue"

返回:

the necessary HTML code for the js and stylesheet includes

calendarInit

public static java.lang.String calendarInit(CmsMessages messages,
                            java.lang.String inputFieldId,
                            java.lang.String triggerButtonId,
                            java.lang.String align,
                            boolean singleClick,
                            boolean weekNumbers,
                            boolean mondayFirst,
                            java.lang.String dateStatusFunc,
                            boolean showTime)

Generates the HTML to initialize the JavaScript calendar element on the end of a page.

This method must be called at the end of a HTML page, e.g. before the closing <body> tag.

参数:

messages - the messages to use (for date and time formats)

inputFieldId - the ID of the input field where the date is pasted to

triggerButtonId - the ID of the button which triggers the calendar

align - initial position of the calendar popup element

singleClick - if true, a single click selects a date and closes the calendar, otherwise calendar is closed by doubleclick

weekNumbers - show the week numbers in the calendar or not

mondayFirst - show monday as first day of week

dateStatusFunc - name of the function which determines if/how a date should be disabled

showTime - true if the time selector should be shown, otherwise false

返回:

the HTML code to initialize a calendar poup element

getCalendarDate

public static long getCalendarDate(CmsMessages messages,
                   java.lang.String dateString,
                   boolean useTime)
                            throws java.text.ParseException

Creates the time in milliseconds from the given parameter.

参数:

messages - the messages that contain the time format definitions

dateString - the String representation of the date

useTime - true if the time should be parsed, too, otherwise false

返回:

the time in milliseconds

抛出:

java.text.ParseException - if something goes wrong

getCalendarJavaDateFormat

public static java.lang.String getCalendarJavaDateFormat(java.lang.String dateFormat)

Parses the JavaScript calendar date format to the java patterns of SimpleDateFormat.

参数:

dateFormat - the dateformat String of the JS calendar

返回:

the parsed SimpleDateFormat pattern String

getCalendarLocalizedTime

public static java.lang.String getCalendarLocalizedTime(java.util.Locale locale,
                                        CmsMessages messages,
                                        long timestamp)

Returns the given timestamp as String formatted in a localized pattern.

参数:

locale - the locale for the time format

messages - the messages that contain the time format definitions

timestamp - the time to format

返回:

the given timestamp as String formatted in a localized pattern

getConfiguration

public java.lang.String getConfiguration(CmsObject cms,
                                A_CmsXmlContentValue schemaType,
                                CmsMessages messages,
                                CmsResource resource,
                                java.util.Locale contentLocale)

从接口复制的说明: I_CmsADEWidget

Returns the configuration string for the ADE content editor widget.

指定者:

getConfiguration 在接口中 I_CmsADEWidget

参数:

cms - the OpenCms context

schemaType - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

返回:

the configuration string

另请参阅:

I_CmsADEWidget.getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)

getCssResourceLinks

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

从接口复制的说明: I_CmsADEWidget

Returns a list of CSS resources required by the widget.

指定者:

getCssResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required CSS resource links

另请参阅:

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

getDefaultDisplayType

public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()

从接口复制的说明: I_CmsADEWidget

Returns the default display type of this widget.

指定者:

getDefaultDisplayType 在接口中 I_CmsADEWidget

返回:

the default display type

另请参阅:

I_CmsADEWidget.getDefaultDisplayType()

getDialogIncludes

public java.lang.String getDialogIncludes(CmsObject cms,
                                 I_CmsWidgetDialog widgetDialog)

从接口复制的说明: I_CmsWidget

Generates the necessary JavaScript inclusion code for this widget.

指定者:

getDialogIncludes 在接口中 I_CmsWidget

覆盖:

getDialogIncludes 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

返回:

the JavaScript inclusion code

另请参阅:

I_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getDialogWidget

public java.lang.String getDialogWidget(CmsObject cms,
                               I_CmsWidgetDialog widgetDialog,
                               I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Generates the widget HTML for the provided widget parameter.

指定者:

getDialogWidget 在接口中 I_CmsWidget

参数:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

返回:

the widget HTML for the provided widget parameter

另请参阅:

I_CmsWidget.getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

getInitCall

public java.lang.String getInitCall()

从接口复制的说明: I_CmsADEWidget

Returns the java script initialization call.

指定者:

getInitCall 在接口中 I_CmsADEWidget

返回:

the java script initialization call

另请参阅:

I_CmsADEWidget.getInitCall()

getJavaScriptResourceLinks

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

从接口复制的说明: I_CmsADEWidget

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

指定者:

getJavaScriptResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required java script resource links

另请参阅:

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

getWidgetName

public java.lang.String getWidgetName()

从接口复制的说明: I_CmsADEWidget

Returns the class name of the widget.

指定者:

getWidgetName 在接口中 I_CmsADEWidget

返回:

the class name

另请参阅:

I_CmsADEWidget.getWidgetName()

getWidgetStringValue

public java.lang.String getWidgetStringValue(CmsObject cms,
                                    I_CmsWidgetDialog widgetDialog,
                                    I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.

指定者:

getWidgetStringValue 在接口中 I_CmsWidget

覆盖:

getWidgetStringValue 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

返回:

the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget

另请参阅:

A_CmsWidget.getWidgetStringValue(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

isInternal

public boolean isInternal()

从接口复制的说明: I_CmsADEWidget

Returns if this is an internal widget.

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

指定者:

isInternal 在接口中 I_CmsADEWidget

返回:

true if this is an internal widget

另请参阅:

I_CmsADEWidget.isInternal()

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

指定者:

newInstance 在接口中 I_CmsWidget

返回:

a duplicate of this widget instance

另请参阅:

I_CmsWidget.newInstance()

setEditorValue

public void setEditorValue(CmsObject cms,
                  java.util.Map<java.lang.String,java.lang.String[]> formParameters,
                  I_CmsWidgetDialog widgetDialog,
                  I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

指定者:

setEditorValue 在接口中 I_CmsWidget

覆盖:

setEditorValue 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

formParameters - the map of parameters to get the value from

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

另请参阅:

I_CmsWidget.setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)