Package org.opencms.gwt.client.ui
Class CmsScrollPanel
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.ScrollPanel
org.opencms.gwt.client.ui.CmsScrollPanel
- All Implemented Interfaces:
com.google.gwt.event.dom.client.HasScrollHandlers,com.google.gwt.event.logical.shared.HasAttachHandlers,com.google.gwt.event.logical.shared.HasResizeHandlers,com.google.gwt.event.shared.HasHandlers,com.google.gwt.user.client.EventListener,com.google.gwt.user.client.ui.AcceptsOneWidget,com.google.gwt.user.client.ui.HasHorizontalScrolling,com.google.gwt.user.client.ui.HasOneWidget,com.google.gwt.user.client.ui.HasScrolling,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.ProvidesResize,com.google.gwt.user.client.ui.RequiresResize,com.google.gwt.user.client.ui.SourcesScrollEvents,Iterable<com.google.gwt.user.client.ui.Widget>,I_CmsDescendantResizeHandler
- Direct Known Subclasses:
CmsScrollPanelImpl
public class CmsScrollPanel
extends com.google.gwt.user.client.ui.ScrollPanel
implements com.google.gwt.event.logical.shared.HasResizeHandlers, I_CmsDescendantResizeHandler
Scroll panel implementation allowing focused scrolling.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classInner class for the resize button.protected classDrag and drop event preview handler.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.DebugIdImplEnabledNested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
com.google.gwt.user.client.ui.HasWidgets.ForIsWidget -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected com.google.gwt.event.shared.HandlerRegistrationThe preview handler registration.Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructor.protectedCmsScrollPanel(com.google.gwt.dom.client.Element root, com.google.gwt.dom.client.Element scrollabel, com.google.gwt.dom.client.Element container) Constructor to be used byCmsScrollPanelImpl. -
Method Summary
Modifier and TypeMethodDescriptioncom.google.gwt.event.shared.HandlerRegistrationaddResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler handler) voidenableFocusedScrolling(boolean enable) Enables or disables the focused scrolling feature.protected voidEnsures the focused scrolling event preview handler is registered.protected voidonAttach()protected voidonDetach()voidThis method should be called when a descendant widget changes its size.booleanremove(com.google.gwt.user.client.ui.Widget w) voidsetDefaultHeight(double height) Sets the default height of the scrolling panel.protected voidsetNewHeight(com.google.gwt.user.client.Event event) Executed on mouse move while dragging.voidsetResizable(boolean resize) Sets the scrollpanel resizeable.protected voidsetStartParameters(com.google.gwt.event.dom.client.MouseDownEvent event) Sets the start parameters of the resize event.Methods inherited from class com.google.gwt.user.client.ui.ScrollPanel
addScrollHandler, addScrollListener, ensureVisible, getContainerElement, getHorizontalScrollPosition, getMaximumHorizontalScrollPosition, getMaximumVerticalScrollPosition, getMinimumHorizontalScrollPosition, getMinimumVerticalScrollPosition, getScrollableElement, getScrollPosition, getVerticalScrollPosition, isTouchScrollingDisabled, onResize, removeScrollListener, scrollToBottom, scrollToLeft, scrollToRight, scrollToTop, setAlwaysShowScrollBars, setHeight, setHorizontalScrollPosition, setScrollPosition, setSize, setTouchScrollingDisabled, setVerticalScrollPosition, setWidthMethods inherited from class com.google.gwt.user.client.ui.SimplePanel
add, getWidget, iterator, setWidget, setWidgetMethods inherited from class com.google.gwt.user.client.ui.Panel
add, adopt, clear, doAttachChildren, doDetachChildren, orphan, removeMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods 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, setPixelSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEventMethods inherited from interface com.google.gwt.user.client.ui.IsWidget
asWidgetMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
m_previewHandlerRegistration
The preview handler registration.
-
-
Constructor Details
-
CmsScrollPanel
public CmsScrollPanel()Constructor.- See Also:
-
CmsScrollPanel
protected CmsScrollPanel(com.google.gwt.dom.client.Element root, com.google.gwt.dom.client.Element scrollabel, com.google.gwt.dom.client.Element container) Constructor to be used byCmsScrollPanelImpl.- Parameters:
root- the root element of the widgetscrollabel- the scrollable element of the widgetcontainer- the container element of the widget
-
-
Method Details
-
enableFocusedScrolling
Enables or disables the focused scrolling feature.Focused scrolling is enabled by default.
- Parameters:
enable-trueto enable the focused scrolling feature
-
onResizeDescendant
Description copied from interface:I_CmsDescendantResizeHandlerThis method should be called when a descendant widget changes its size.- Specified by:
onResizeDescendantin interfaceI_CmsDescendantResizeHandler- See Also:
-
remove
- Specified by:
removein interfacecom.google.gwt.user.client.ui.HasWidgets- Overrides:
removein classcom.google.gwt.user.client.ui.SimplePanel- See Also:
-
setDefaultHeight
Sets the default height of the scrolling panel.- Parameters:
height- the default height
-
setResizable
Sets the scrollpanel resizeable.- Parameters:
resize- true if the scrollpanel should be resizeable.
-
ensureFocusedScrolling
Ensures the focused scrolling event preview handler is registered. -
onAttach
- Overrides:
onAttachin classcom.google.gwt.user.client.ui.ScrollPanel- See Also:
-
onDetach
- Overrides:
onDetachin classcom.google.gwt.user.client.ui.ScrollPanel- See Also:
-
setNewHeight
Executed on mouse move while dragging.- Parameters:
event- the event
-
setStartParameters
Sets the start parameters of the resize event.- Parameters:
event- the mouse event