Package uk.ac.rdg.resc.godiva.client.widgets

Class DialogBoxWithCloseButton

  • 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.safehtml.client.HasSafeHtml, 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.HasHTML, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasText, 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.MouseListener, com.google.gwt.user.client.ui.SourcesPopupEvents, Iterable<com.google.gwt.user.client.ui.Widget>, EventListener
    Direct Known Subclasses:
    StartEndTimePopup
    public class DialogBoxWithCloseButton
extends com.google.gwt.user.client.ui.DialogBox
    Extended DialogBox widget with close button inside the pop-up header
    Author:
    L.Pelov Slight modification to have a hardcoded close image. Original code from: http://code.google.com/p/wcinteractions/source/browse/trunk/MVP/ src/com/mvp/client/ui/widget/DialogBoxExt.java Modification to allow custom centring, Guy Griffiths

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  DialogBoxWithCloseButton.CentrePosIF  

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

        com.google.gwt.user.client.ui.DialogBox.Caption, com.google.gwt.user.client.ui.DialogBox.CaptionImpl

      • 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 com.google.gwt.user.client.ui.UIObject

        DEBUG_ID_PREFIX

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void center()
      This centres the dialog box, but uses a DialogBoxWithCloseButton.CentrePosIF to define the centre position (so that for example we can centre this box over a map, or other widget)
      protected boolean isHeaderCloseControlEvent​(com.google.gwt.dom.client.NativeEvent event)
      Function checks if the browser event is was inside the caption region
      protected boolean isWidgetEvent​(com.google.gwt.dom.client.NativeEvent event, com.google.gwt.user.client.ui.Widget w)
      Function checks if event was inside a given widget
      void onBrowserEvent​(com.google.gwt.user.client.Event event)
      Overrides the browser event from the DialogBox
      void setHTML​(com.google.gwt.safehtml.shared.SafeHtml html)  
      void setHTML​(String html)  

      • Methods inherited from class com.google.gwt.user.client.ui.DialogBox

        beginDragging, continueDragging, doAttachChildren, doDetachChildren, endDragging, getCaption, getHTML, getText, hide, onEnsureDebugId, onMouseDown, onMouseEnter, onMouseLeave, onMouseMove, onMouseUp, onPreviewNativeEvent, setText, show

      • Methods inherited from class com.google.gwt.user.client.ui.DecoratedPopupPanel

        clear, getCellElement, getWidget, iterator, remove, setWidget

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

        addAutoHidePartner, addCloseHandler, addPopupListener, getAnimationType, getContainerElement, 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, setAnimationType, setAutoHideEnabled, setAutoHideOnHistoryEventsEnabled, setGlassEnabled, setGlassStyleName, setHeight, setModal, setPopupPosition, setPopupPositionAndShow, setPreviewingAllNativeEvents, setTitle, setVisible, setWidth, showRelativeTo

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

        add, 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, onDetach, 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, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, toString

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

        fireEvent

    • Method Detail

      • setHTML

        public void setHTML​(String html)
        Specified by:
        setHTML in interface com.google.gwt.user.client.ui.HasHTML
        Overrides:
        setHTML in class com.google.gwt.user.client.ui.DialogBox

      • setHTML

        public void setHTML​(com.google.gwt.safehtml.shared.SafeHtml html)
        Specified by:
        setHTML in interface com.google.gwt.safehtml.client.HasSafeHtml
        Overrides:
        setHTML in class com.google.gwt.user.client.ui.DialogBox

      • isHeaderCloseControlEvent

        protected boolean isHeaderCloseControlEvent​(com.google.gwt.dom.client.NativeEvent event)
        Function checks if the browser event is was inside the caption region
        Parameters:
        event - browser event
        Returns:
        true if event inside the caption panel (DialogBox header)

      • onBrowserEvent

        public void onBrowserEvent​(com.google.gwt.user.client.Event event)
        Overrides the browser event from the DialogBox
        Specified by:
        onBrowserEvent in interface com.google.gwt.user.client.EventListener
        Overrides:
        onBrowserEvent in class com.google.gwt.user.client.ui.DialogBox

      • isWidgetEvent

        protected boolean isWidgetEvent​(com.google.gwt.dom.client.NativeEvent event,
                                com.google.gwt.user.client.ui.Widget w)
        Function checks if event was inside a given widget
        Parameters:
        event - - current event
        w - - widget to prove if event was inside
        Returns:
        - true if event inside the given widget

      • center

        public void center()
        This centres the dialog box, but uses a DialogBoxWithCloseButton.CentrePosIF to define the centre position (so that for example we can centre this box over a map, or other widget)
        Overrides:
        center in class com.google.gwt.user.client.ui.PopupPanel