org.opencms.gwt.client.ui

类 CmsPopup

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

所有已实现的接口:

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

直接已知子类:

A_CmsListItemSelectDialog, A_CmsUploadDialog, CmsAlertDialog, CmsAvailabilityDialog, CmsCategoryDialog, CmsConfirmRemoveDialog, CmsCopyLocaleDialog, CmsErrorDialog, CmsFormDialog, CmsFramePopup, CmsGalleryPopup, CmsLockReportDialog, CmsPreviewDialog, CmsPropertyDefinitionDialog, CmsPublishConfirmationDialog, CmsPublishDialog, CmsRemovedElementDeletionDialog, CmsRenameDialog, CmsReplaceDialog, CmsResourceInfoDialog, CmsRestoreDialog, CmsSeoOptionsDialog, CmsToolbarPopup

public class CmsPopup
extends com.google.gwt.user.client.ui.PopupPanel
implements I_CmsAutoHider

Provides a pop up dialog base.

从以下版本开始:

8.0.0

嵌套类概要

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.PopupPanel

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

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

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

从接口继承的嵌套类/接口 com.google.gwt.user.client.ui.HasWidgets

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

字段概要

字段

限定符和类型	字段和说明
protected com.google.gwt.user.client.Command	m_closeCommand The close command.
protected boolean	m_notificationWidgetInstalled Flag which indicates whether the notification widget has already been installed.
protected int	m_windowWidth The window width.

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsPopup() Constructor.
CmsPopup(int width) Constructor setting the width of the dialog.
CmsPopup(java.lang.String caption) Constructor setting the dialog caption.
CmsPopup(java.lang.String caption, int width) Constructor setting caption and width.
CmsPopup(java.lang.String title, com.google.gwt.user.client.ui.Widget content) The constructor.

方法概要

方法

限定符和类型	方法和说明
void	add(com.google.gwt.user.client.ui.Widget w) Adds the given child widget.
protected void	add(com.google.gwt.user.client.ui.Widget child, com.google.gwt.dom.client.Element container) Adds a new child widget to the panel, attaching its Element to the specified container Element.
void	addButton(com.google.gwt.user.client.ui.Widget button) Adds a button widget to the button panel.
void	addButton(com.google.gwt.user.client.ui.Widget button, int position) Adds a button widget to the button panel before the given position.
void	addDialogClose(com.google.gwt.user.client.Command cmd) Adds a close "button" to the top of the popup.
protected int	adjustIndex(com.google.gwt.user.client.ui.Widget child, int beforeIndex) Adjusts beforeIndex to account for the possibility that the given widget is already a child of this panel.
protected void	beginDragging(com.google.gwt.event.dom.client.MouseDownEvent event) Called on mouse down in the caption area, begins the dragging loop by turning on event capture.
void	catchNotifications() Replaces current notification widget by an overlay.
void	center()
void	centerHorizontally(int top) Shows the dialog and centers it horizontally, but positions it at a fixed vertical position.
protected void	checkIndexBoundsForAccess(int index) Checks that index is in the range [0, getWidgetCount()), which is the valid range on accessible indexes.
protected void	checkIndexBoundsForInsertion(int index) Checks that index is in the range [0, getWidgetCount()], which is the valid range for indexes on an insertion.
void	clear()
protected void	continueDragging(com.google.gwt.event.dom.client.MouseMoveEvent event) Called on mouse move in the caption area, continues dragging if it was started by beginDragging(com.google.gwt.event.dom.client.MouseDownEvent).
protected A_CmsNotificationWidget	createDialogNotificationWidget() Creates a new notification widget for this dialog.
protected void	doAttachChildren()
protected void	doDetachChildren()
protected void	endDragging(com.google.gwt.event.dom.client.MouseUpEvent event) Called on mouse up in the caption area, ends dragging by ending event capture.
int	getAvailableHeight(int fixedContentHeight) Returns the maximum available height inside the popup.
java.lang.String	getCaption() Returns the dialog caption text.
protected com.google.gwt.user.client.ui.WidgetCollection	getChildren() Gets the list of children contained in this panel.
protected com.google.gwt.user.client.Element	getContainerElement()
com.google.gwt.user.client.ui.Widget	getWidget(int index) Returns the child widget with the given index.
int	getWidgetCount() Returns the number of child widgets.
int	getWidgetIndex(com.google.gwt.user.client.ui.IsWidget child) Returns the index of the given widget.
int	getWidgetIndex(com.google.gwt.user.client.ui.Widget child) Returns the index of the given child widget.
int	getWidth() Returns the dialog content width, -1 if not set.
boolean	hasCaption() Returns true if a caption is set for this popup false otherwise.
void	hide() Hides the widget.
protected void	insert(com.google.gwt.user.client.ui.Widget child, com.google.gwt.dom.client.Element container, int beforeIndex, boolean domInsert) Insert a new child Widget into this Panel at a specified index, attaching its Element to the specified container Element.
void	insert(com.google.gwt.user.client.ui.Widget w, int beforeIndex) Inserts a child widget before the given index.
void	insertFront(com.google.gwt.user.client.ui.Widget widget) Inserts a widget as the first widget in the popup.
protected void	installNotificationWidget() Sets the notification widget.
java.util.Iterator<com.google.gwt.user.client.ui.Widget>	iterator()
void	onBrowserEvent(com.google.gwt.user.client.Event event)
protected void	onDetach() Override to work around the glass overlay still showing after dialog hide.
protected void	onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event)
boolean	remove(int index) Removes a child widget.
boolean	remove(com.google.gwt.user.client.ui.Widget w)
void	removeAllButtons() Removes all buttons.
void	removeButton(com.google.gwt.user.client.ui.Widget button) Removes the given button widget from the button panel.
void	removePadding() Removes the padding from the popup's content.
void	setBackgroundColor(java.lang.String color) Sets the popup's content background.
void	setCaption(java.lang.String caption) Sets the captions text.
void	setHeight(int height) Sets the height for the popup content.
void	setHeight(java.lang.String height) 已过时。
void	setMainContent(com.google.gwt.user.client.ui.Widget w) Replaces the content from the main widget.
void	setPixelSize(int width, int height) 已过时。
void	setPositionFixed() Sets the popup's dialog position to 'fixed'.
void	setSize(java.lang.String width, java.lang.String height) 已过时。
void	setSpecialBackgroundClass(java.lang.String cssClassName) Sets an additional CSS class to the main content element.
void	setUseAnimation(boolean use) Sets the use animation flag.
void	setWidget(com.google.gwt.user.client.ui.Widget w) 已过时。
void	setWidth(int width) Sets the width for the popup content.
void	setWidth(java.lang.String width) 已过时。
void	show()
protected void	showArrow(com.google.gwt.dom.client.Element arrow) Appends the arrow element to the popup's dialog.
static com.google.gwt.user.client.ui.Widget	wrapWithBorderPadding(com.google.gwt.user.client.ui.Widget w) Wraps the given Widget with a cornered border, padding and margin.

从类继承的方法 com.google.gwt.user.client.ui.PopupPanel

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

从类继承的方法 com.google.gwt.user.client.ui.SimplePanel

getWidget, setWidget

从类继承的方法 com.google.gwt.user.client.ui.Panel

add, adopt, adopt, disown, orphan, remove

从类继承的方法 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

从类继承的方法 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, unsinkEvents

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.gwt.client.ui.I_CmsAutoHider

addAutoHidePartner, isAutoHideEnabled, isAutoHideOnHistoryEventsEnabled, removeAutoHidePartner, setAutoHideEnabled, setAutoHideOnHistoryEventsEnabled

从接口继承的方法 com.google.gwt.event.shared.HasHandlers

fireEvent

字段详细资料

m_closeCommand

protected com.google.gwt.user.client.Command m_closeCommand

The close command.

m_notificationWidgetInstalled

protected boolean m_notificationWidgetInstalled

Flag which indicates whether the notification widget has already been installed.

m_windowWidth

protected int m_windowWidth

The window width.

构造器详细资料

CmsPopup

public CmsPopup()

Constructor.

CmsPopup

public CmsPopup(int width)

Constructor setting the width of the dialog.

参数:

width - the width to set

CmsPopup

public CmsPopup(java.lang.String caption)

Constructor setting the dialog caption.

参数:

caption - the caption to set

CmsPopup

public CmsPopup(java.lang.String caption,
        int width)

Constructor setting caption and width.

参数:

caption - the caption to set

width - the width to set

CmsPopup

public CmsPopup(java.lang.String title,
        com.google.gwt.user.client.ui.Widget content)

The constructor.

参数:

title - the title and heading of the dialog

content - the content widget

方法详细资料

wrapWithBorderPadding

public static com.google.gwt.user.client.ui.Widget wrapWithBorderPadding(com.google.gwt.user.client.ui.Widget w)

Wraps the given Widget with a cornered border, padding and margin.

参数:

w - the widget to wrap

返回:

a new widget that wraps the given one

add

public void add(com.google.gwt.user.client.ui.Widget w)

Adds the given child widget.

指定者:

add 在接口中 com.google.gwt.user.client.ui.HasWidgets

覆盖:

add 在类中 com.google.gwt.user.client.ui.SimplePanel

参数:

w - the widget

addButton

public void addButton(com.google.gwt.user.client.ui.Widget button)

Adds a button widget to the button panel.

参数:

button - the button widget

addButton

public void addButton(com.google.gwt.user.client.ui.Widget button,
             int position)

Adds a button widget to the button panel before the given position.

参数:

button - the button widget

position - the position to insert the button

addDialogClose

public void addDialogClose(com.google.gwt.user.client.Command cmd)

Adds a close "button" to the top of the popup.

参数:

cmd - the command that should be executed when the close button is clicked

catchNotifications

public void catchNotifications()

Replaces current notification widget by an overlay.

center

public void center()

覆盖:

center 在类中 com.google.gwt.user.client.ui.PopupPanel

另请参阅:

PopupPanel.center()

centerHorizontally

public void centerHorizontally(int top)

Shows the dialog and centers it horizontally, but positions it at a fixed vertical position.

参数:

top - the top position

clear

public void clear()

指定者:

clear 在接口中 com.google.gwt.user.client.ui.HasWidgets

覆盖:

clear 在类中 com.google.gwt.user.client.ui.Panel

另请参阅:

Panel.clear()

getAvailableHeight

public int getAvailableHeight(int fixedContentHeight)

Returns the maximum available height inside the popup.

参数:

fixedContentHeight - fixed content height to deduct from the available height

返回:

the maximum available height

getCaption

public java.lang.String getCaption()

Returns the dialog caption text.

返回:

the dialog caption

getWidget

public com.google.gwt.user.client.ui.Widget getWidget(int index)

Returns the child widget with the given index.

参数:

index - the index

返回:

the child widget

getWidgetCount

public int getWidgetCount()

Returns the number of child widgets.

返回:

the number of child widgets

getWidgetIndex

public int getWidgetIndex(com.google.gwt.user.client.ui.IsWidget child)

Returns the index of the given widget.

参数:

child - the child widget

返回:

the index of the child widget

getWidgetIndex

public int getWidgetIndex(com.google.gwt.user.client.ui.Widget child)

Returns the index of the given child widget.

参数:

child - the child widget

返回:

the index

getWidth

public int getWidth()

Returns the dialog content width, -1 if not set.

返回:

the dialog content width

hasCaption

public boolean hasCaption()

Returns true if a caption is set for this popup false otherwise.

返回:

true if a caption is set for this popup false otherwise

hide

public void hide()

从接口复制的说明: I_CmsAutoHider

Hides the widget.

指定者:

hide 在接口中 I_CmsAutoHider

覆盖:

hide 在类中 com.google.gwt.user.client.ui.PopupPanel

另请参阅:

PopupPanel.hide()

insert

public void insert(com.google.gwt.user.client.ui.Widget w,
          int beforeIndex)
            throws java.lang.IndexOutOfBoundsException

Inserts a child widget before the given index.

参数:

w - the child widget

beforeIndex - the index

抛出:

java.lang.IndexOutOfBoundsException - if the index is out of bounds

insertFront

public void insertFront(com.google.gwt.user.client.ui.Widget widget)

Inserts a widget as the first widget in the popup.

参数:

widget - the widget to insert

iterator

public java.util.Iterator<com.google.gwt.user.client.ui.Widget> iterator()

指定者:

iterator 在接口中 com.google.gwt.user.client.ui.HasWidgets

指定者:

iterator 在接口中 java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

覆盖:

iterator 在类中 com.google.gwt.user.client.ui.SimplePanel

另请参阅:

SimplePanel.iterator()

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

指定者:

onBrowserEvent 在接口中 com.google.gwt.user.client.EventListener

覆盖:

onBrowserEvent 在类中 com.google.gwt.user.client.ui.Widget

另请参阅:

Widget.onBrowserEvent(com.google.gwt.user.client.Event)

remove

public boolean remove(int index)

Removes a child widget.

参数:

index - the index of the widget to remove

返回:

true if the there was a widget at the given index to remove

remove

public boolean remove(com.google.gwt.user.client.ui.Widget w)

指定者:

remove 在接口中 com.google.gwt.user.client.ui.HasWidgets

覆盖:

remove 在类中 com.google.gwt.user.client.ui.SimplePanel

另请参阅:

SimplePanel.remove(com.google.gwt.user.client.ui.Widget)

removeAllButtons

public void removeAllButtons()

Removes all buttons.

removeButton

public void removeButton(com.google.gwt.user.client.ui.Widget button)

Removes the given button widget from the button panel.

参数:

button - the button widget to remove

removePadding

public void removePadding()

Removes the padding from the popup's content.

setBackgroundColor

public void setBackgroundColor(java.lang.String color)

Sets the popup's content background.

参数:

color - the color to set

setCaption

public void setCaption(java.lang.String caption)

Sets the captions text.

参数:

caption - the text to set

setHeight

public void setHeight(int height)

Sets the height for the popup content.

参数:

height - the height in pixels

setHeight

@Deprecated
public void setHeight(java.lang.String height)

已过时。

覆盖:

setHeight 在类中 com.google.gwt.user.client.ui.PopupPanel

另请参阅:

PopupPanel.setHeight(java.lang.String)

setMainContent

public void setMainContent(com.google.gwt.user.client.ui.Widget w)

Replaces the content from the main widget.

参数:

w - the widget that should replace the main content

setPixelSize

@Deprecated
public void setPixelSize(int width,
                           int height)

已过时。

覆盖:

setPixelSize 在类中 com.google.gwt.user.client.ui.UIObject

另请参阅:

UIObject.setSize(java.lang.String, java.lang.String)

setPositionFixed

public void setPositionFixed()

Sets the popup's dialog position to 'fixed'.

setSize

@Deprecated
public void setSize(java.lang.String width,
                      java.lang.String height)

已过时。

覆盖:

setSize 在类中 com.google.gwt.user.client.ui.UIObject

另请参阅:

UIObject.setSize(java.lang.String, java.lang.String)

setSpecialBackgroundClass

public void setSpecialBackgroundClass(java.lang.String cssClassName)

Sets an additional CSS class to the main content element.

参数:

cssClassName - the CSS class to set

setUseAnimation

public void setUseAnimation(boolean use)

Sets the use animation flag.

参数:

use - true if the animation should be used, default is true

setWidget

@Deprecated
public void setWidget(com.google.gwt.user.client.ui.Widget w)

已过时。

Unsupported operation.

指定者:

setWidget 在接口中 com.google.gwt.user.client.ui.HasOneWidget

覆盖:

setWidget 在类中 com.google.gwt.user.client.ui.PopupPanel

另请参阅:

PopupPanel.setWidget(com.google.gwt.user.client.ui.Widget)

setWidth

public void setWidth(int width)

Sets the width for the popup content.

参数:

width - the width in pixels

setWidth

@Deprecated
public void setWidth(java.lang.String width)

已过时。

覆盖:

setWidth 在类中 com.google.gwt.user.client.ui.PopupPanel

另请参阅:

PopupPanel.setWidth(java.lang.String)

show

public void show()

覆盖:

show 在类中 com.google.gwt.user.client.ui.PopupPanel

另请参阅:

PopupPanel.show()

add

protected void add(com.google.gwt.user.client.ui.Widget child,
       com.google.gwt.dom.client.Element container)

Adds a new child widget to the panel, attaching its Element to the specified container Element.

参数:

child - the child widget to be added

container - the element within which the child will be contained

adjustIndex

protected int adjustIndex(com.google.gwt.user.client.ui.Widget child,
              int beforeIndex)

Adjusts beforeIndex to account for the possibility that the given widget is already a child of this panel.

参数:

child - the widget that might be an existing child

beforeIndex - the index at which it will be added to this panel

返回:

the modified index

beginDragging

protected void beginDragging(com.google.gwt.event.dom.client.MouseDownEvent event)

Called on mouse down in the caption area, begins the dragging loop by turning on event capture.

参数:

event - the mouse down event that triggered dragging

另请参阅:

DOM.setCapture(com.google.gwt.user.client.Element), continueDragging(com.google.gwt.event.dom.client.MouseMoveEvent)

checkIndexBoundsForAccess

protected void checkIndexBoundsForAccess(int index)

Checks that index is in the range [0, getWidgetCount()), which is the valid range on accessible indexes.

参数:

index - the index being accessed

checkIndexBoundsForInsertion

protected void checkIndexBoundsForInsertion(int index)

Checks that index is in the range [0, getWidgetCount()], which is the valid range for indexes on an insertion.

参数:

index - the index where insertion will occur

continueDragging

protected void continueDragging(com.google.gwt.event.dom.client.MouseMoveEvent event)

Called on mouse move in the caption area, continues dragging if it was started by beginDragging(com.google.gwt.event.dom.client.MouseDownEvent).

参数:

event - the mouse move event that continues dragging

另请参阅:

beginDragging(com.google.gwt.event.dom.client.MouseDownEvent), endDragging(com.google.gwt.event.dom.client.MouseUpEvent)

createDialogNotificationWidget

protected A_CmsNotificationWidget createDialogNotificationWidget()

Creates a new notification widget for this dialog.

返回:

the notification widget for this dialog

doAttachChildren

protected void doAttachChildren()

覆盖:

doAttachChildren 在类中 com.google.gwt.user.client.ui.Panel

另请参阅:

Panel.doAttachChildren()

doDetachChildren

protected void doDetachChildren()

覆盖:

doDetachChildren 在类中 com.google.gwt.user.client.ui.Panel

另请参阅:

Panel.doDetachChildren()

endDragging

protected void endDragging(com.google.gwt.event.dom.client.MouseUpEvent event)

Called on mouse up in the caption area, ends dragging by ending event capture.

参数:

event - the mouse up event that ended dragging

另请参阅:

DOM.releaseCapture(com.google.gwt.user.client.Element), beginDragging(com.google.gwt.event.dom.client.MouseDownEvent), endDragging(com.google.gwt.event.dom.client.MouseUpEvent)

getChildren

protected com.google.gwt.user.client.ui.WidgetCollection getChildren()

Gets the list of children contained in this panel.

返回:

a collection of child widgets

getContainerElement

protected com.google.gwt.user.client.Element getContainerElement()

覆盖:

getContainerElement 在类中 com.google.gwt.user.client.ui.PopupPanel

另请参阅:

PopupPanel.getContainerElement()

insert

protected void insert(com.google.gwt.user.client.ui.Widget child,
          com.google.gwt.dom.client.Element container,
          int beforeIndex,
          boolean domInsert)

Insert a new child Widget into this Panel at a specified index, attaching its Element to the specified container Element. The child Element will either be attached to the container at the same index, or simply appended to the container, depending on the value of domInsert.

参数:

child - the child Widget to be added

container - the Element within which child will be contained

beforeIndex - the index before which child will be inserted

domInsert - if true, insert child into container at beforeIndex; otherwise append child to the end of container.

installNotificationWidget

protected void installNotificationWidget()

Sets the notification widget.

onDetach

protected void onDetach()

Override to work around the glass overlay still showing after dialog hide.

覆盖:

onDetach 在类中 com.google.gwt.user.client.ui.Widget

另请参阅:

Widget.onDetach()

onPreviewNativeEvent

protected void onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event)

覆盖:

onPreviewNativeEvent 在类中 com.google.gwt.user.client.ui.PopupPanel

另请参阅:

PopupPanel.onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent)

showArrow

protected void showArrow(com.google.gwt.dom.client.Element arrow)

Appends the arrow element to the popup's dialog.

参数:

arrow - the arrow element to add