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 Object
implements I_CmsWidgetDialog

Inner class to generate the I_CmsWidgetDialog.

Constructor Summary

Constructors

Constructor	Description
CmsDummyWidgetDialog(Locale locale, CmsMessages message)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	button(String href, String target, String image, String label, int type)	Generates a button for the widget dialog.
String	buttonBar(int segment)	Returns the html for a button bar.
String	buttonBarHorizontalLine()	Generates a horizontal button bar separator line with maximum width.
String	buttonBarSeparator(int leftPixel, int rightPixel)	Generates a button bar separator.
String	buttonBarSpacer(int width)	Returns the html for an invisible spacer between button bar contents like buttons, labels, etc.
String	buttonBarStartTab(int leftPixel, int rightPixel)	Generates a button bar starter tab.
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.
Set<String>	getHelpMessageIds()	Returns a set of help messages ids that are already included on the widget dialog.
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.
String	getUserAgent()	Returns the "user-agent" of the current request, or null 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.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsDummyWidgetDialog

public CmsDummyWidgetDialog(Locale locale,
 CmsMessages message)

Constructor.

Parameters:

locale - the locale of the dialog

message - the message of the dialog

Method Details

button

public String button(String href,
 String target,
 String image,
 String label,
 int type)

Description copied from interface: I_CmsWidgetDialog

Generates a button for the widget dialog.

Specified by:

button in interface I_CmsWidgetDialog

Parameters:

href - the href link for the button, if none is given the button will be disabled

target - the href link target for the button, if none is given the target will be same window

image - the image name for the button, skin path will be automattically added as prefix

label - the label for the text of the button

type - 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 String buttonBar(int segment)

Description copied from interface: I_CmsWidgetDialog

Returns the html for a button bar.

Specified by:

buttonBar in interface I_CmsWidgetDialog

Parameters:

segment - the HTML segment (START / END)

Returns:

a button bar html start / end segment

See Also:

• I_CmsWidgetDialog.buttonBar(int)

buttonBarHorizontalLine

public String buttonBarHorizontalLine()

Description copied from interface: I_CmsWidgetDialog

Generates a horizontal button bar separator line with maximum width.

Specified by:

buttonBarHorizontalLine in interface I_CmsWidgetDialog

Returns:

a horizontal button bar separator line

See Also:

• I_CmsWidgetDialog.buttonBarHorizontalLine()

buttonBarSeparator

public String buttonBarSeparator(int leftPixel,
 int rightPixel)

Description copied from interface: I_CmsWidgetDialog

Generates a button bar separator.

Specified by:

buttonBarSeparator in interface I_CmsWidgetDialog

Parameters:

leftPixel - the amount of pixel left to the separator

rightPixel - the amount of pixel right to the separator

Returns:

a button bar separator

See Also:

• I_CmsWidgetDialog.buttonBarSeparator(int, int)

buttonBarSpacer

public 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 interface I_CmsWidgetDialog

Parameters:

width - the width of the invisible spacer

Returns:

the html for the invisible spacer

See Also:

• I_CmsWidgetDialog.buttonBarSpacer(int)

buttonBarStartTab

public String buttonBarStartTab(int leftPixel,
 int rightPixel)

Description copied from interface: I_CmsWidgetDialog

Generates a button bar starter tab.

Specified by:

buttonBarStartTab in interface I_CmsWidgetDialog

Parameters:

leftPixel - the amount of pixel left to the starter

rightPixel - the amount of pixel right to the starter

Returns:

a button bar starter tab

See Also:

• I_CmsWidgetDialog.buttonBarStartTab(int, int)

dialogHorizontalSpacer

public String dialogHorizontalSpacer(int width)

Description copied from interface: I_CmsWidgetDialog

Builds an invisible horiziontal spacer with the specified width.

Specified by:

dialogHorizontalSpacer in interface I_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 interface I_CmsWidgetDialog

Returns:

the style setting to use when generating buttons for this widget dialog

See Also:

• I_CmsWidgetDialog.getButtonStyle()

getHelpMessageIds

public Set<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 interface I_CmsWidgetDialog

Returns:

a set of help messages ids that are already included on the widget dialog

See Also:

• I_CmsWidgetDialog.getHelpMessageIds()

getLocale

public Locale getLocale()

Description copied from interface: I_CmsWidgetDialog

Returns the current users locale setting.

Specified by:

getLocale in interface I_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 interface I_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 String getUserAgent()

Description copied from interface: I_CmsWidgetDialog

Returns the "user-agent" of the current request, or null in case no request is available.

Specified by:

getUserAgent in interface I_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 interface I_CmsWidgetDialog

Returns:

true if using the new style

See Also:

• I_CmsWidgetDialog.useNewStyle()