|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Describes a widget enabled dialog.
Method Summary | |
java.lang.String |
button(java.lang.String href,
java.lang.String target,
java.lang.String image,
java.lang.String label,
int type)
Generates a button for the widget dialog. |
java.lang.String |
buttonBar(int segment)
Returns the html for a button bar. |
java.lang.String |
buttonBarHorizontalLine()
Generates a horizontal button bar separator line with maximum width. |
java.lang.String |
buttonBarSeparator(int leftPixel,
int rightPixel)
Generates a button bar separator. |
java.lang.String |
buttonBarSpacer(int width)
Returns the html for an invisible spacer between button bar contents like buttons, labels, etc. |
java.lang.String |
buttonBarStartTab(int leftPixel,
int rightPixel)
Generates a button bar starter tab. |
java.lang.String |
calendarIncludes()
Displays a javascript calendar element with the standard "opencms" style. |
java.lang.String |
calendarInit(java.lang.String inputFieldId,
java.lang.String triggerButtonId,
java.lang.String align,
boolean singleClick,
boolean weekNumbers,
boolean mondayFirst,
java.lang.String dateStatusFunc,
boolean showTime)
Initializes a javascript calendar element to be shown on a page. |
java.lang.String |
dialogHorizontalSpacer(int width)
Builds an invisible horiziontal spacer with the specified width. |
int |
getButtonStyle()
Returns the style setting to use when generating buttons for this widget dialog. |
long |
getCalendarDate(java.lang.String dateString,
boolean useTime)
Creates the time in milliseconds from the given parameter. |
java.lang.String |
getCalendarLocalizedTime(long timestamp)
Returns the given timestamp as String formatted in a localized pattern. |
java.util.Set |
getHelpMessageIds()
Returns a set of help messages ids that are already included on the widget dialog. |
java.util.Locale |
getLocale()
Returns the current users locale setting. |
CmsMessages |
getMessages()
Returns a messages object used to render localized keys for the widget dialog. |
java.lang.String |
getUserAgent()
Returns the "user-agent" of the current request, or null in case no
request is available. |
boolean |
useNewStyle()
Tests if we are working with the new administration dialog style. |
Method Detail |
public java.lang.String button(java.lang.String href, java.lang.String target, java.lang.String image, java.lang.String label, int type)
href
- the href link for the button, if none is given the button will be disabledtarget
- the href link target for the button, if none is given the target will be same windowimage
- the image name for the button, skin path will be automattically added as prefixlabel
- the label for the text of the buttontype
- 0: image only (default), 1: image and text, 2: text only
CmsWorkplace.button(String, String, String, String, int)
public java.lang.String buttonBar(int segment)
segment
- the HTML segment (START / END)
public java.lang.String buttonBarHorizontalLine()
public java.lang.String buttonBarSeparator(int leftPixel, int rightPixel)
leftPixel
- the amount of pixel left to the separatorrightPixel
- the amount of pixel right to the separator
public java.lang.String buttonBarSpacer(int width)
width
- the width of the invisible spacer
CmsWorkplace.buttonBarSpacer(int)
public java.lang.String buttonBarStartTab(int leftPixel, int rightPixel)
leftPixel
- the amount of pixel left to the starterrightPixel
- the amount of pixel right to the starter
public java.lang.String calendarIncludes()
Creates the HTML javascript and stylesheet includes for the head of the page.
public java.lang.String calendarInit(java.lang.String inputFieldId, java.lang.String triggerButtonId, java.lang.String align, boolean singleClick, boolean weekNumbers, boolean mondayFirst, java.lang.String dateStatusFunc, boolean showTime)
This method must be called at the end of a HTML page, e.g. before the closing <body> tag.
inputFieldId
- the ID of the input field where the date is pasted totriggerButtonId
- the ID of the button which triggers the calendaralign
- initial position of the calendar popup elementsingleClick
- if true, a single click selects a date and closes the calendar, otherwise calendar is closed by doubleclickweekNumbers
- show the week numbers in the calendar or notmondayFirst
- show monday as first day of weekdateStatusFunc
- name of the function which determines if/how a date should be disabledshowTime
- true if the time selector should be shown, otherwise false
public java.lang.String dialogHorizontalSpacer(int width)
width
- the width of the spacer in pixels
CmsDialog.dialogHorizontalSpacer(int)
public int getButtonStyle()
CmsUserSettings.getEditorButtonStyle()
public long getCalendarDate(java.lang.String dateString, boolean useTime) throws java.text.ParseException
dateString
- the String representation of the dateuseTime
- true if the time should be parsed, too, otherwise false
java.text.ParseException
- if something goes wrongpublic java.lang.String getCalendarLocalizedTime(long timestamp)
timestamp
- the time to format
public java.util.Set getHelpMessageIds()
This is used to prevent the occurence of multiple html div
id's with the same
value when generating the help texts. For valid html, each id can be used only once.
public java.util.Locale getLocale()
CmsWorkplace.getLocale()
,
CmsRequestContext.getLocale()
public CmsMessages getMessages()
public java.lang.String getUserAgent()
null
in case no
request is available.
public boolean useNewStyle()
This param is not intended for external use.
true
if using the new style
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |