Package org.opencms.gwt.client.ui

Class CmsToolbarPopup

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.CmsToolbarPopup

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, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>, I_CmsAutoHider

public class CmsToolbarPopup
extends CmsPopup

A popup which can be displayed below buttons in a toolbar.

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

Modifier and Type	Field	Description
protected com.google.gwt.dom.client.Element	m_arrow	The 'arrow-shaped' connector element above the popup.
protected com.google.gwt.dom.client.Element	m_baseElement	The base element of the toolbar button.
protected com.google.gwt.user.client.ui.ButtonBase	m_button	The toolbar button to which this popup belongs.
protected boolean	m_isToolbarMode	The 'toolbar mode' flag.
protected int	m_toolbarWidth	The toolbar 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
CmsToolbarPopup(com.google.gwt.user.client.ui.ButtonBase button, boolean toolbarMode, com.google.gwt.dom.client.Element baseElement)	Creates a new toolbar popup.

Method Summary

Modifier and Type	Method	Description
static int	getAvailableHeight()	Calculates the popup height to use.
static int	getAvailableWidth()	Calculates the popup width to use.
void	position()	Positions the popup below the toolbar button.
void	positionDeferred()	Defers execution of the position() method.
void	setToolbarMode(boolean isToolbarMode)	Sets the isToolbarMode.

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

add, add, addButton, addButton, addDialogClose, adjustIndex, beginDragging, catchNotifications, center, 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, show, 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, onLoad, 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

Field Detail

m_arrow

protected com.google.gwt.dom.client.Element m_arrow

The 'arrow-shaped' connector element above the popup.

m_button

protected com.google.gwt.user.client.ui.ButtonBase m_button

The toolbar button to which this popup belongs.

m_toolbarWidth

protected int m_toolbarWidth

The toolbar width.

m_isToolbarMode

protected boolean m_isToolbarMode

The 'toolbar mode' flag.

m_baseElement

protected com.google.gwt.dom.client.Element m_baseElement

The base element of the toolbar button.

Constructor Detail

CmsToolbarPopup

public CmsToolbarPopup(com.google.gwt.user.client.ui.ButtonBase button,
                       boolean toolbarMode,
                       com.google.gwt.dom.client.Element baseElement)

Creates a new toolbar popup.

Parameters:

button - the toolbar button to which this popup belongs

toolbarMode - the toolbar mode flag

baseElement - the base element of the toolbar button

Method Detail

getAvailableHeight

public static int getAvailableHeight()

Calculates the popup height to use.

Returns:

the height

getAvailableWidth

public static int getAvailableWidth()

Calculates the popup width to use.

Returns:

the width

position

public void position()

Positions the popup below the toolbar button.

positionDeferred

public void positionDeferred()

Defers execution of the position() method.

setToolbarMode

public void setToolbarMode(boolean isToolbarMode)

Sets the isToolbarMode.

Parameters:

isToolbarMode - the isToolbarMode to set