Package org.opencms.gwt.client.ui.preferences

Class CmsUserSettingsDialog

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.SimplePanel

com.google.gwt.user.client.ui.PopupPanel

org.opencms.gwt.client.ui.CmsPopup

org.opencms.gwt.client.ui.input.form.CmsFormDialog

org.opencms.gwt.client.ui.preferences.CmsUserSettingsDialog

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.EventPreview, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesPopupEvents, Iterable<com.google.gwt.user.client.ui.Widget>, I_CmsAutoHider, I_CmsFormSubmitHandler

public class CmsUserSettingsDialog
extends CmsFormDialog
implements I_CmsFormSubmitHandler

Dialog used for changing the user settings.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.gwt.client.ui.CmsPopup

CmsPopup.HistoryHandler

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.PopupPanel

com.google.gwt.user.client.ui.PopupPanel.AnimationType, com.google.gwt.user.client.ui.PopupPanel.PositionCallback

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class org.opencms.gwt.client.ui.input.form.CmsFormDialog

m_form, m_formHandler, MAX_DIALOG_WIDTH, STANDARD_DIALOG_WIDTH

Fields inherited from class org.opencms.gwt.client.ui.CmsPopup

DEFAULT_WIDTH, m_closeCommand, m_notificationWidgetInstalled, m_windowWidth, WIDE_WIDTH

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsUserSettingsDialog(org.opencms.gwt.shared.CmsUserSettingsBean userSettings, Runnable finishAction)	Creates a new widget instance.

Method Summary

Modifier and Type	Method	Description
static void	loadAndShow(Runnable finishAction)	Loads the user settings dialog.
protected void	onLoad()
void	onSubmitForm(CmsForm form, Map<String,String> fieldValues, Set<String> editedFields)	The method which should be called when a CmsForm is submitted.
protected void	updateHeight()	Updates the panel height depending on the content of the current tab.

Methods inherited from class org.opencms.gwt.client.ui.input.form.CmsFormDialog

center, getForm, getOkButton, initContent, onClickCancel, onClickOk, registerPreviewHandler, removePreviewHandler, setFormHandler, setOkButtonEnabled, show

Methods inherited from class org.opencms.gwt.client.ui.CmsPopup

add, add, addButton, addButton, addDialogClose, adjustIndex, beginDragging, catchNotifications, centerHorizontally, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, clear, continueDragging, createDialogNotificationWidget, doAttachChildren, doDetachChildren, endDragging, getAvailableHeight, getCaption, getChildren, getContainerElement, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, getWidth, hasCaption, hide, hide, insert, insert, insertFront, installNotificationWidget, iterator, onBrowserEvent, onDetach, onPreviewNativeEvent, remove, remove, removeAllButtons, removeButton, removePadding, setBackgroundColor, setCaption, setHeight, setHeight, setMainContent, setPixelSize, setPositionFixed, setSize, setSpecialBackgroundClass, setUseAnimation, setWidget, setWidth, setWidth, showArrow, wrapWithBorderPadding

Methods inherited from class com.google.gwt.user.client.ui.PopupPanel

addAutoHidePartner, addCloseHandler, addPopupListener, getAnimationType, getGlassElement, getGlassStyleName, getOffsetHeight, getOffsetWidth, getPopupLeft, getPopupTop, getStyleElement, getTitle, isAnimationEnabled, isAutoHideEnabled, isAutoHideOnHistoryEventsEnabled, isGlassEnabled, isModal, isPreviewingAllNativeEvents, isShowing, isVisible, onEventPreview, onKeyDownPreview, onKeyPressPreview, onKeyUpPreview, onUnload, removeAutoHidePartner, removePopupListener, setAnimationEnabled, setAnimationType, setAutoHideEnabled, setAutoHideOnHistoryEventsEnabled, setGlassEnabled, setGlassStyleName, setModal, setPopupPosition, setPopupPositionAndShow, setPreviewingAllNativeEvents, setTitle, setVisible, showRelativeTo

Methods inherited from class com.google.gwt.user.client.ui.SimplePanel

getWidget, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface org.opencms.gwt.client.ui.I_CmsAutoHider

addAutoHidePartner, isAutoHideEnabled, isAutoHideOnHistoryEventsEnabled, removeAutoHidePartner, setAutoHideEnabled, setAutoHideOnHistoryEventsEnabled

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

CmsUserSettingsDialog

public CmsUserSettingsDialog(org.opencms.gwt.shared.CmsUserSettingsBean userSettings,
 Runnable finishAction)

Creates a new widget instance.

Parameters:

userSettings - the current user settings

finishAction - the action to execute when the user has edited the user settings

Method Details

loadAndShow

public static void loadAndShow(Runnable finishAction)

Loads the user settings dialog.

Parameters:

finishAction - the action to execute after the user has changed his preferences

onSubmitForm

public void onSubmitForm(CmsForm form,
 Map<String,String> fieldValues,
 Set<String> editedFields)

Description copied from interface: I_CmsFormSubmitHandler

The method which should be called when a CmsForm is submitted.

The map passed as a parameter will contain key-value pairs where the key is the name of the field and the value is the value obtained from the field. It is explicitly allowed that the value is null; this means that the property is set to 'default'.

Specified by:

onSubmitForm in interface I_CmsFormSubmitHandler

Parameters:

form - the form

fieldValues - a map of field values

editedFields - the fields which have been edited

See Also:

• I_CmsFormSubmitHandler.onSubmitForm(org.opencms.gwt.client.ui.input.form.CmsForm, java.util.Map, java.util.Set)

onLoad

protected void onLoad()

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

See Also:

• Widget.onLoad()

updateHeight

protected void updateHeight()

Updates the panel height depending on the content of the current tab.