Package org.opencms.widgets
Class A_CmsWidget.CmsDummyWidgetDialog
- java.lang.Object
-
- org.opencms.widgets.A_CmsWidget.CmsDummyWidgetDialog
-
- All Implemented Interfaces:
I_CmsWidgetDialog
- Enclosing class:
- A_CmsWidget
public class A_CmsWidget.CmsDummyWidgetDialog extends java.lang.Object implements I_CmsWidgetDialog
Inner class to generate the I_CmsWidgetDialog.
-
-
Constructor Summary
Constructors Constructor Description CmsDummyWidgetDialog(java.util.Locale locale, CmsMessages message)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete 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.CmsResource
getResource()
Gets the resource being edited.java.lang.String
getUserAgent()
Returns the "user-agent" of the current request, ornull
in case no request is available.void
setResource(CmsResource resource)
Sets the resource being edited.boolean
useNewStyle()
Tests if we are working with the new administration dialog style.
-
-
-
Constructor Detail
-
CmsDummyWidgetDialog
public CmsDummyWidgetDialog(java.util.Locale locale, CmsMessages message)
Constructor.- Parameters:
locale
- the locale of the dialogmessage
- the message of the dialog
-
-
Method Detail
-
button
public java.lang.String button(java.lang.String href, java.lang.String target, java.lang.String image, java.lang.String label, int type)
Description copied from interface:I_CmsWidgetDialog
Generates a button for the widget dialog.- Specified by:
button
in interfaceI_CmsWidgetDialog
- 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:
I_CmsWidgetDialog.button(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int)
-
buttonBar
public java.lang.String buttonBar(int segment)
Description copied from interface:I_CmsWidgetDialog
Returns the html for a button bar.- Specified by:
buttonBar
in interfaceI_CmsWidgetDialog
- Parameters:
segment
- the HTML segment (START / END)- Returns:
- a button bar html start / end segment
- See Also:
I_CmsWidgetDialog.buttonBar(int)
-
buttonBarHorizontalLine
public java.lang.String buttonBarHorizontalLine()
Description copied from interface:I_CmsWidgetDialog
Generates a horizontal button bar separator line with maximum width.- Specified by:
buttonBarHorizontalLine
in interfaceI_CmsWidgetDialog
- Returns:
- a horizontal button bar separator line
- See Also:
I_CmsWidgetDialog.buttonBarHorizontalLine()
-
buttonBarSeparator
public java.lang.String buttonBarSeparator(int leftPixel, int rightPixel)
Description copied from interface:I_CmsWidgetDialog
Generates a button bar separator.- Specified by:
buttonBarSeparator
in interfaceI_CmsWidgetDialog
- Parameters:
leftPixel
- the amount of pixel left to the separatorrightPixel
- the amount of pixel right to the separator- Returns:
- a button bar separator
- See Also:
I_CmsWidgetDialog.buttonBarSeparator(int, int)
-
buttonBarSpacer
public java.lang.String buttonBarSpacer(int width)
Description copied from interface:I_CmsWidgetDialog
Returns the html for an invisible spacer between button bar contents like buttons, labels, etc.- Specified by:
buttonBarSpacer
in interfaceI_CmsWidgetDialog
- Parameters:
width
- the width of the invisible spacer- Returns:
- the html for the invisible spacer
- See Also:
I_CmsWidgetDialog.buttonBarSpacer(int)
-
buttonBarStartTab
public java.lang.String buttonBarStartTab(int leftPixel, int rightPixel)
Description copied from interface:I_CmsWidgetDialog
Generates a button bar starter tab.- Specified by:
buttonBarStartTab
in interfaceI_CmsWidgetDialog
- Parameters:
leftPixel
- the amount of pixel left to the starterrightPixel
- the amount of pixel right to the starter- Returns:
- a button bar starter tab
- See Also:
I_CmsWidgetDialog.buttonBarStartTab(int, int)
-
dialogHorizontalSpacer
public java.lang.String dialogHorizontalSpacer(int width)
Description copied from interface:I_CmsWidgetDialog
Builds an invisible horiziontal spacer with the specified width.- Specified by:
dialogHorizontalSpacer
in interfaceI_CmsWidgetDialog
- Parameters:
width
- the width of the spacer in pixels- Returns:
- an invisible horiziontal spacer with the specified width
- See Also:
I_CmsWidgetDialog.dialogHorizontalSpacer(int)
-
getButtonStyle
public int getButtonStyle()
Description copied from interface:I_CmsWidgetDialog
Returns the style setting to use when generating buttons for this widget dialog.- Specified by:
getButtonStyle
in interfaceI_CmsWidgetDialog
- Returns:
- the style setting to use when generating buttons for this widget dialog
- See Also:
I_CmsWidgetDialog.getButtonStyle()
-
getHelpMessageIds
public java.util.Set<java.lang.String> getHelpMessageIds()
Description copied from interface:I_CmsWidgetDialog
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.- Specified by:
getHelpMessageIds
in interfaceI_CmsWidgetDialog
- Returns:
- a set of help messages ids that are already included on the widget dialog
- See Also:
I_CmsWidgetDialog.getHelpMessageIds()
-
getLocale
public java.util.Locale getLocale()
Description copied from interface:I_CmsWidgetDialog
Returns the current users locale setting.- Specified by:
getLocale
in interfaceI_CmsWidgetDialog
- Returns:
- the current users locale setting
- See Also:
I_CmsWidgetDialog.getLocale()
-
getMessages
public CmsMessages getMessages()
Description copied from interface:I_CmsWidgetDialog
Returns a messages object used to render localized keys for the widget dialog.- Specified by:
getMessages
in interfaceI_CmsWidgetDialog
- Returns:
- a messages object used to render localized keys for the widget dialog
- See Also:
I_CmsWidgetDialog.getMessages()
-
getResource
public CmsResource getResource()
Gets the resource being edited.- Returns:
- the resource being edited
-
getUserAgent
public java.lang.String getUserAgent()
Description copied from interface:I_CmsWidgetDialog
Returns the "user-agent" of the current request, ornull
in case no request is available.- Specified by:
getUserAgent
in interfaceI_CmsWidgetDialog
- Returns:
- the "user-agent" of the current request
- See Also:
I_CmsWidgetDialog.getUserAgent()
-
setResource
public void setResource(CmsResource resource)
Sets the resource being edited.- Parameters:
resource
- the resource being edited
-
useNewStyle
public boolean useNewStyle()
Description copied from interface:I_CmsWidgetDialog
Tests if we are working with the new administration dialog style.This param is not intended for external use.
- Specified by:
useNewStyle
in interfaceI_CmsWidgetDialog
- Returns:
true
if using the new style- See Also:
I_CmsWidgetDialog.useNewStyle()
-
-