com.smartgwt.mobile.client.widgets

Class Popover

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

com.smartgwt.mobile.client.widgets.Canvas

com.smartgwt.mobile.client.internal.widgets.Popup

com.smartgwt.mobile.client.widgets.Window

com.smartgwt.mobile.client.widgets.Dialog

com.smartgwt.mobile.client.widgets.Popover

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, 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.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.smartgwt.mobile.client.internal.test.AutoTestLocatable, com.smartgwt.mobile.client.internal.widgets.events.HasPopupDismissedHandlers, HasButtonClickHandlers, HasClickHandlers, HasCloseClickHandlers, HasShowContextMenuHandlers, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

public class Popover
extends Dialog

Nested Class Summary

Nested classes/interfaces inherited from class com.smartgwt.mobile.client.internal.widgets.Popup

com.smartgwt.mobile.client.internal.widgets.Popup.PopupState

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

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

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 and Description
static com.smartgwt.mobile.client.internal.theme.iphone.PopoverCssResourceIPhone	_CSS

Fields inherited from class com.smartgwt.mobile.client.widgets.Dialog

APPLY, CANCEL, DONE, NO, OK, YES

Fields inherited from class com.smartgwt.mobile.client.widgets.Canvas

_CONTENT_CHANGED_EVENT_TYPE, _HISTORY_ENABLED, _REQUEST_SCROLL_TO_EVENT_TYPE, id, touched

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
	Popover()
protected	Popover(com.smartgwt.mobile.client.internal.widgets.PopoverImpl impl)
	Popover(java.lang.String title)
	Popover(java.lang.String title, Canvas child)

Method Summary

Modifier and Type	Method and Description
protected void	_destroyPopup()
void	_doDefaultAction()
boolean	_getSmallFormFactor()
int	getPreferredContentHeight() The preferred height in pixels of the content area, which holds the child widget.
boolean	getShowCancelButton() The "Cancel" button is shown if showCancelButton is true; hidden otherwise.
boolean	getShowDoneButton() The "Done" button is shown if showDoneButton is true; hidden otherwise.
java.lang.Boolean	getSmallFormFactor()
void	setChild(Canvas child) Sets the child widget of the Popover, which is added to the content area.
void	setPreferredContentHeight(int preferredContentHeight) Sets preferredContentHeight.
void	setShowCancelButton(java.lang.Boolean showCancelButton)
void	setShowDoneButton(java.lang.Boolean showDoneButton)
void	setSmallFormFactor(java.lang.Boolean smallFormFactor)
void	show(Canvas target)
void	showForArea(int clientX, int clientY, int offsetWidth, int offsetHeight) Show the popover for the given area of interest.
void	showForArea(Rectangle rect) Show the popover for the given area of interest.

Methods inherited from class com.smartgwt.mobile.client.widgets.Dialog

_getButtonsContainerElem, _getChildFromLocatorSubstring, addButtonClickHandler, applyClick, cancelClick, doDefaultAction, doneClick, getDefaultAction, getMessage, noClick, okClick, setButtons, setDefaultAction, setMessage, yesClick

Methods inherited from class com.smartgwt.mobile.client.widgets.Window

_doHide, _doShow, _getAttributeFromSplitLocator, _getBackgroundElem, _getHeaderElem, _getHideAnimationName, _getImpl, _getInnerAttributeFromSplitLocator, _getInnerElement, _getShowAnimationName, _makeModalMask, _setHideAnimationName, _setShowAnimationName, addCloseClickHandler, getAnimateHideEffect, getAnimateShowEffect, getBackgroundStyle, getBodyStyle, getDismissOnOutsideClick, getIsModal, getModalMask, getModalMaskStyle, getShowHeader, getTitle, hide, onBrowserEvent, setAnimateHideEffect, setAnimateShowEffect, setBackgroundStyle, setBodyStyle, setDismissOnOutsideClick, setIsModal, setModalMaskStyle, setShowHeader, setTitle, show

Methods inherited from class com.smartgwt.mobile.client.internal.widgets.Popup

_addPopupDismissedHandler, _getIsModal, _getModalMask, _getModalMaskStyle, _getStateAsString, _isHidden, _isHiding, _isShowing, _isShown, _onHidden, _onShown, _setHistoryMarker, _setIsModal, _setModalMaskStyle, destroy, onLoad, onUnload

Methods inherited from class com.smartgwt.mobile.client.widgets.Canvas

_add, _booleanValue, _fireContentChangedEvent, _fireContentChangedEvent, _fireRequestScrollToEvent, _getAndroidWindowSoftInputMode, _getFixNavigationBarPositionDuringKeyboardFocus, _getHideTabBarDuringKeyboardFocus, _hideAddressBar, _hideAddressBarNow, _insert, _isDifferent, _isHDPIDisplay, _isIOS4OrOlder, _isIOS5, _isIOSMin6_0, _isStandaloneMode, _nativeParseFloat, _removeClassName, _setClassName, _setHandleDisabled, _sinkAnimationEndEvent, _sinkContentChangedEvent, _sinkFocusInEvent, _sinkFocusOutEvent, _sinkInputEvent, _sinkRequestScrollToEvent, _sinkTransitionEndEvent, _triggerDebugger, addChild, addChild, addChild, addClickHandler, addShowContextMenuHandler, disable, enable, getContextMenu, getID, getInnerHTML, getMargin, hasChild, hasChild, isAndroid, isDisabled, isEnabled, isIPad, isIPhone, isSafari, isStandAlone, isUIWebView, parseDimension, removeChild, removeChild, setContents, setContextMenu, setDisabled, setElement, setID, setMargin, setStyleName, split, useIOSNativeScrolling

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

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, add, adopt, clear, doAttachChildren, doDetachChildren, 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, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, setVisible, setWidth, 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 java.lang.Iterable

forEach, spliterator

Field Detail

_CSS

@SGWTInternal
public static final com.smartgwt.mobile.client.internal.theme.iphone.PopoverCssResourceIPhone _CSS

Constructor Detail

Popover

protected Popover(com.smartgwt.mobile.client.internal.widgets.PopoverImpl impl)

Popover

public Popover()

Popover

public Popover(java.lang.String title)

Popover

public Popover(java.lang.String title,
               Canvas child)

Method Detail

_destroyPopup

protected void _destroyPopup()

Overrides:

_destroyPopup in class Dialog

getShowCancelButton

public final boolean getShowCancelButton()

The "Cancel" button is shown if showCancelButton is true; hidden otherwise.

Returns:

whether to show the Cancel button. Default value: true

setShowCancelButton

public void setShowCancelButton(java.lang.Boolean showCancelButton)

getShowDoneButton

public final boolean getShowDoneButton()

The "Done" button is shown if showDoneButton is true; hidden otherwise.

Returns:

whether to show the Done button. Default value: true

setShowDoneButton

public void setShowDoneButton(java.lang.Boolean showDoneButton)

getSmallFormFactor

public final java.lang.Boolean getSmallFormFactor()

_getSmallFormFactor

@SGWTInternal
public final boolean _getSmallFormFactor()

setSmallFormFactor

public void setSmallFormFactor(java.lang.Boolean smallFormFactor)

setChild

public void setChild(Canvas child)

Sets the child widget of the Popover, which is added to the content area.

NOTE: The Popover may need to limit the size of its content area so that it fits entirely on screen. If a widget is moderately bulky, it is recommended to use a ScrollablePanel for the child widget so that any overflow remains accessible to the user. See the Widgets -> Dialogs -> TableView with Popover example in Showcase for a sample.

Parameters:

child - child widget.

See Also:

getPreferredContentHeight()

getPreferredContentHeight

public final int getPreferredContentHeight()

The preferred height in pixels of the content area, which holds the child widget. The Popover will try to set the height of the content area to at least this many pixels (allowing more space if the child widget's offsetHeight is more than the preferred content height); however, in no case will the content height be set so that a part of the Popover is off-screen.

Returns:

the preferred content height in pixels. Default value: 325

setPreferredContentHeight

public void setPreferredContentHeight(int preferredContentHeight)

Sets preferredContentHeight.

Parameters:

preferredContentHeight - the new preferred content height.

Throws:

java.lang.IllegalArgumentException - if preferredContentHeight is negative.

_doDefaultAction

@SGWTInternal
public final void _doDefaultAction()

show

public final void show(Canvas target)

showForArea

public final void showForArea(Rectangle rect)

Show the popover for the given area of interest.

Parameters:

rect - the area of interest.

showForArea

public void showForArea(int clientX,
                        int clientY,
                        int offsetWidth,
                        int offsetHeight)

Show the popover for the given area of interest.

Parameters:

clientX - X coordinate relative to the viewport of the upper left corner of the area of interest.

clientY - Y coordinate relative to the viewport of the upper left corner of the area of interest.

offsetWidth - offset width of the area of interest.

offsetHeight - offset height of the area of interest.