Package org.opencms.widgets
Interface I_CmsWidgetDialog
-
- All Known Implementing Classes:
A_CmsWidget.CmsDummyWidgetDialog
,CmsXmlContentEditor
public interface I_CmsWidgetDialog
Describes a widget enabled dialog.- Since:
- 6.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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
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.java.util.Set<java.lang.String>
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, ornull
in case no request is available.boolean
useNewStyle()
Tests if we are working with the new administration dialog style.
-
-
-
Method Detail
-
button
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.- Parameters:
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- Returns:
- a button for the OpenCms workplace
- See Also:
CmsWorkplace.button(String, String, String, String, int)
-
buttonBar
java.lang.String buttonBar(int segment)
Returns the html for a button bar.- Parameters:
segment
- the HTML segment (START / END)- Returns:
- a button bar html start / end segment
-
buttonBarHorizontalLine
java.lang.String buttonBarHorizontalLine()
Generates a horizontal button bar separator line with maximum width.- Returns:
- a horizontal button bar separator line
-
buttonBarSeparator
java.lang.String buttonBarSeparator(int leftPixel, int rightPixel)
Generates a button bar separator.- Parameters:
leftPixel
- the amount of pixel left to the separatorrightPixel
- the amount of pixel right to the separator- Returns:
- a button bar separator
-
buttonBarSpacer
java.lang.String buttonBarSpacer(int width)
Returns the html for an invisible spacer between button bar contents like buttons, labels, etc.- Parameters:
width
- the width of the invisible spacer- Returns:
- the html for the invisible spacer
- See Also:
CmsWorkplace.buttonBarSpacer(int)
-
buttonBarStartTab
java.lang.String buttonBarStartTab(int leftPixel, int rightPixel)
Generates a button bar starter tab.- Parameters:
leftPixel
- the amount of pixel left to the starterrightPixel
- the amount of pixel right to the starter- Returns:
- a button bar starter tab
-
dialogHorizontalSpacer
java.lang.String dialogHorizontalSpacer(int width)
Builds an invisible horiziontal spacer with the specified width.- Parameters:
width
- the width of the spacer in pixels- Returns:
- an invisible horiziontal spacer with the specified width
- See Also:
CmsDialog.dialogHorizontalSpacer(int)
-
getButtonStyle
int getButtonStyle()
Returns the style setting to use when generating buttons for this widget dialog.- Returns:
- the style setting to use when generating buttons for this widget dialog
- See Also:
CmsUserSettings.getEditorButtonStyle()
-
getHelpMessageIds
java.util.Set<java.lang.String> getHelpMessageIds()
Returns a set of help messages ids that are already included on the widget dialog.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.- Returns:
- a set of help messages ids that are already included on the widget dialog
-
getLocale
java.util.Locale getLocale()
Returns the current users locale setting.- Returns:
- the current users locale setting
- See Also:
CmsWorkplace.getLocale()
,CmsRequestContext.getLocale()
-
getMessages
CmsMessages getMessages()
Returns a messages object used to render localized keys for the widget dialog.- Returns:
- a messages object used to render localized keys for the widget dialog
-
getUserAgent
java.lang.String getUserAgent()
Returns the "user-agent" of the current request, ornull
in case no request is available.- Returns:
- the "user-agent" of the current request
-
useNewStyle
boolean useNewStyle()
Tests if we are working with the new administration dialog style.This param is not intended for external use.
- Returns:
true
if using the new style
-
-