Class CmsScrollBar

  • All Implemented Interfaces:
    com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasScrollHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.Integer>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<java.lang.Integer>, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasFocus, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasValue<java.lang.Integer>, com.google.gwt.user.client.ui.HasVerticalScrolling, 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.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesFocusEvents, com.google.gwt.user.client.ui.SourcesKeyboardEvents, com.google.gwt.user.client.ui.SourcesMouseEvents, com.google.gwt.user.client.ui.SourcesMouseWheelEvents, com.google.gwt.user.client.ui.VerticalScrollbar, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>, I_CmsDescendantResizeHandler

    public class CmsScrollBar
    extends com.google.gwt.user.client.ui.FocusPanel
    implements I_CmsDescendantResizeHandler, com.google.gwt.user.client.ui.HasValue<java.lang.Integer>, com.google.gwt.user.client.ui.VerticalScrollbar
    A custom scroll bar to be used with CmsScrollPanel.

    • Nested Class Summary

      • 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 int m_stepSize
      The size of the increments between knob positions.
      • Fields inherited from class com.google.gwt.user.client.ui.UIObject

        DEBUG_ID_PREFIX
    • Constructor Summary

      Constructors 
      Constructor Description
      CmsScrollBar​(com.google.gwt.dom.client.Element scrollableElement, com.google.gwt.dom.client.Element containerElement)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.google.gwt.event.shared.HandlerRegistration addScrollHandler​(com.google.gwt.event.dom.client.ScrollHandler handler)  
      com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler​(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.Integer> handler)  
      int getMaximumVerticalScrollPosition()  
      int getMinimumVerticalScrollPosition()  
      protected com.google.gwt.dom.client.Element getScrollableElement()
      Returns the associated scrollable element.
      int getScrollHeight()  
      java.lang.Integer getValue()  
      int getVerticalScrollPosition()  
      void isResizeable​(boolean reziseable)  
      protected void onAttach()  
      void onBrowserEvent​(com.google.gwt.user.client.Event event)
      Listen for events that will move the knob.
      protected void onDetach()  
      void onResizeDescendant()
      This method should be called when a descendant widget changes its size.
      protected void redraw()
      Redraws the scroll bar.
      void setScrollHeight​(int height)  
      void setValue​(java.lang.Integer value)  
      void setValue​(java.lang.Integer value, boolean fireEvents)  
      void setVerticalScrollPosition​(int position)  
      protected void shiftDown​(int shift)
      Shifts the scroll position down.
      protected void shiftUp​(int shift)
      Shifts the scroll position up.
      • Methods inherited from class com.google.gwt.user.client.ui.FocusPanel

        addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getTabIndex, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setFocus, setTabIndex
      • Methods inherited from class com.google.gwt.user.client.ui.SimplePanel

        add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget
      • Methods inherited from class com.google.gwt.user.client.ui.Panel

        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, onLoad, onUnload, 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, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, 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 com.google.gwt.user.client.ui.IsWidget

        asWidget
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Field Detail

      • m_stepSize

        protected int m_stepSize
        The size of the increments between knob positions.
    • Constructor Detail

      • CmsScrollBar

        public CmsScrollBar​(com.google.gwt.dom.client.Element scrollableElement,
                            com.google.gwt.dom.client.Element containerElement)
        Constructor.

        Parameters:
        scrollableElement - the scrollable element
        containerElement - the scroll content
    • Method Detail

      • addScrollHandler

        public com.google.gwt.event.shared.HandlerRegistration addScrollHandler​(com.google.gwt.event.dom.client.ScrollHandler handler)
        Specified by:
        addScrollHandler in interface com.google.gwt.event.dom.client.HasScrollHandlers
        See Also:
        HasScrollHandlers.addScrollHandler(com.google.gwt.event.dom.client.ScrollHandler)
      • addValueChangeHandler

        public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler​(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.Integer> handler)
        Specified by:
        addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.Integer>
        See Also:
        HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
      • getMaximumVerticalScrollPosition

        public int getMaximumVerticalScrollPosition()
        Specified by:
        getMaximumVerticalScrollPosition in interface com.google.gwt.user.client.ui.HasVerticalScrolling
        See Also:
        HasVerticalScrolling.getMaximumVerticalScrollPosition()
      • getMinimumVerticalScrollPosition

        public int getMinimumVerticalScrollPosition()
        Specified by:
        getMinimumVerticalScrollPosition in interface com.google.gwt.user.client.ui.HasVerticalScrolling
        See Also:
        HasVerticalScrolling.getMinimumVerticalScrollPosition()
      • getScrollHeight

        public int getScrollHeight()
        Specified by:
        getScrollHeight in interface com.google.gwt.user.client.ui.VerticalScrollbar
        See Also:
        VerticalScrollbar.getScrollHeight()
      • getValue

        public java.lang.Integer getValue()
        Specified by:
        getValue in interface com.google.gwt.user.client.ui.HasValue<java.lang.Integer>
        Specified by:
        getValue in interface com.google.gwt.user.client.TakesValue<java.lang.Integer>
        See Also:
        HasValue.getValue()
      • getVerticalScrollPosition

        public int getVerticalScrollPosition()
        Specified by:
        getVerticalScrollPosition in interface com.google.gwt.user.client.ui.HasVerticalScrolling
        See Also:
        HasVerticalScrolling.getVerticalScrollPosition()
      • isResizeable

        public void isResizeable​(boolean reziseable)
        Parameters:
        reziseable - true if the panel is resizeable
      • onBrowserEvent

        public final void onBrowserEvent​(com.google.gwt.user.client.Event event)
        Listen for events that will move the knob.
        Specified by:
        onBrowserEvent in interface com.google.gwt.user.client.EventListener
        Overrides:
        onBrowserEvent in class com.google.gwt.user.client.ui.Widget
        Parameters:
        event - the event that occurred
      • setScrollHeight

        public void setScrollHeight​(int height)
        Specified by:
        setScrollHeight in interface com.google.gwt.user.client.ui.VerticalScrollbar
        See Also:
        VerticalScrollbar.setScrollHeight(int)
      • setValue

        public void setValue​(java.lang.Integer value)
        Specified by:
        setValue in interface com.google.gwt.user.client.ui.HasValue<java.lang.Integer>
        Specified by:
        setValue in interface com.google.gwt.user.client.TakesValue<java.lang.Integer>
        See Also:
        HasValue.setValue(java.lang.Object)
      • setValue

        public void setValue​(java.lang.Integer value,
                             boolean fireEvents)
        Specified by:
        setValue in interface com.google.gwt.user.client.ui.HasValue<java.lang.Integer>
        See Also:
        HasValue.setValue(java.lang.Object, boolean)
      • setVerticalScrollPosition

        public void setVerticalScrollPosition​(int position)
        Specified by:
        setVerticalScrollPosition in interface com.google.gwt.user.client.ui.HasVerticalScrolling
        See Also:
        HasVerticalScrolling.setVerticalScrollPosition(int)
      • getScrollableElement

        protected com.google.gwt.dom.client.Element getScrollableElement()
        Returns the associated scrollable element.

        Returns:
        the associated scrollable element
      • onAttach

        protected void onAttach()
        Overrides:
        onAttach in class com.google.gwt.user.client.ui.Widget
        See Also:
        Widget.onAttach()
      • onDetach

        protected void onDetach()
        Overrides:
        onDetach in class com.google.gwt.user.client.ui.Widget
        See Also:
        Widget.onDetach()
      • redraw

        protected void redraw()
        Redraws the scroll bar.

      • shiftDown

        protected void shiftDown​(int shift)
        Shifts the scroll position down.

        Parameters:
        shift - the shift size
      • shiftUp

        protected void shiftUp​(int shift)
        Shifts the scroll position up.

        Parameters:
        shift - the shift size