We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.client.widget.escalator.
Class ScrollbarBundle.VerticalScrollbarBundle
- java.lang.Object
-
- com.vaadin.client.widget.escalator.ScrollbarBundle
-
- com.vaadin.client.widget.escalator.ScrollbarBundle.VerticalScrollbarBundle
-
All Implemented Interfaces:
Enclosing class:
public static final class ScrollbarBundle.VerticalScrollbarBundle extends ScrollbarBundleA representation of a single vertical scrollbar.
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.vaadin.client.widget.escalator.ScrollbarBundle
ScrollbarBundle.Direction, ScrollbarBundle.HorizontalScrollbarBundle, ScrollbarBundle.VerticalScrollbarBundle, ScrollbarBundle.VisibilityChangeEvent, ScrollbarBundle.VisibilityHandler
-
-
Field Summary
-
Fields inherited from class com.vaadin.client.widget.escalator.ScrollbarBundle
isInvisibleScrollbar, root, scrollSizeElement
-
-
Constructor Summary
Constructors Constructor Description VerticalScrollbarBundle()
-
Method Summary
All Methods Modifier and Type Method Description ScrollbarBundle.DirectiongetDirection()Returns the scroll direction of this scrollbar bundle.
protected voidinternalForceScrollbar(boolean enable)Sets the overflow-x (for horizontal) or overflow-y (for vertical) property to
"scroll"if enabled, or clears the property if disabled.StringinternalGetOffsetSize()Returns the width (for horizontal) or height (for vertical) css property for the root element.
protected StringinternalGetScrollbarThickness()Gets the scrollbar's thickness as defined in the DOM.
protected intinternalGetScrollPos()Retrieves the element's scroll position (scrollTop or scrollLeft).
protected StringinternalGetScrollSize()Returns the width (for horizontal) or height (for vertical) css property for the scroll size element.
protected voidinternalSetOffsetSize(double px)Modifies
root'sdimensions in the axis the scrollbar is representing.protected voidinternalSetScrollbarThickness(double px)Modifies
scrollSizeElement'sdimensions in the opposite axis to what the scrollbar is representing.protected voidinternalSetScrollPos(int px)Modifies the element's scroll position (scrollTop or scrollLeft).
protected voidinternalSetScrollSize(double px)Modifies
scrollSizeElement'sdimensions in such a way that the scrollbar is able to scroll a certain number of pixels in the axis it is representing.voidsetStylePrimaryName(String primaryStyleName)Sets the primary style name.
-
Methods inherited from class com.vaadin.client.widget.escalator.ScrollbarBundle
addScrollHandler, addVisibilityHandler, forceScrollbar, getElement, getHandlerManager, getOffsetSize, getScrollbarThickness, getScrollPos, getScrollSize, isLocked, isWorkPending, onLoad, recalculateMaxScrollPos, setLocked, setOffsetSize, setOffsetSizeAndScrollSize, setScrollbarThickness, setScrollPos, setScrollPosByDelta, setScrollSize, showsScrollHandle
-
-
-
-
Method Detail
-
setStylePrimaryName
public void setStylePrimaryName(String primaryStyleName)Description copied from class:
ScrollbarBundleSets the primary style name.
Overrides:
setStylePrimaryNamein classScrollbarBundleParameters:
primaryStyleName- The primary style name to use
-
internalSetScrollPos
protected void internalSetScrollPos(int px)Description copied from class:
ScrollbarBundleModifies the element's scroll position (scrollTop or scrollLeft).
Note: The parameter here is a type of integer (instead of a double) by design. The browsers internally convert all double values into an integer value. To make this fact explicit, this API has chosen to force integers already at this level.
Specified by:
internalSetScrollPosin classScrollbarBundleParameters:
px- integer pixel value to scroll to
-
internalGetScrollPos
protected int internalGetScrollPos()Description copied from class:
ScrollbarBundleRetrieves the element's scroll position (scrollTop or scrollLeft).
Note: The parameter here is a type of integer (instead of a double) by design. The browsers internally convert all double values into an integer value. To make this fact explicit, this API has chosen to force integers already at this level.
Specified by:
internalGetScrollPosin classScrollbarBundleReturns:
integer pixel value of the scroll position
-
internalSetScrollSize
protected void internalSetScrollSize(double px)Description copied from class:
ScrollbarBundleModifies
scrollSizeElement'sdimensions in such a way that the scrollbar is able to scroll a certain number of pixels in the axis it is representing.Specified by:
internalSetScrollSizein classScrollbarBundleParameters:
px- the new size ofScrollbarBundle.scrollSizeElementin the dimension this scrollbar is representing
-
internalGetScrollSize
protected String internalGetScrollSize()Description copied from class:
ScrollbarBundleReturns the width (for horizontal) or height (for vertical) css property for the scroll size element.
Specified by:
internalGetScrollSizein classScrollbarBundleReturns:
the relevant size property based on orientation
-
internalSetOffsetSize
protected void internalSetOffsetSize(double px)Description copied from class:
ScrollbarBundleModifies
root'sdimensions in the axis the scrollbar is representing.Specified by:
internalSetOffsetSizein classScrollbarBundleParameters:
px- the new size ofScrollbarBundle.rootin the dimension this scrollbar is representing
-
internalGetOffsetSize
public String internalGetOffsetSize()Description copied from class:
ScrollbarBundleReturns the width (for horizontal) or height (for vertical) css property for the root element.
Specified by:
internalGetOffsetSizein classScrollbarBundleReturns:
the relevant size property based on orientation
-
internalSetScrollbarThickness
protected void internalSetScrollbarThickness(double px)Description copied from class:
ScrollbarBundleModifies
scrollSizeElement'sdimensions in the opposite axis to what the scrollbar is representing.Specified by:
internalSetScrollbarThicknessin classScrollbarBundleParameters:
px- the dimension thatScrollbarBundle.scrollSizeElementshould take in the opposite axis to what the scrollbar is representing
-
internalGetScrollbarThickness
protected String internalGetScrollbarThickness()Description copied from class:
ScrollbarBundleGets the scrollbar's thickness as defined in the DOM.
Specified by:
internalGetScrollbarThicknessin classScrollbarBundleReturns:
the scrollbar's thickness as defined in the DOM, in pixels
-
internalForceScrollbar
protected void internalForceScrollbar(boolean enable)Description copied from class:
ScrollbarBundleSets the overflow-x (for horizontal) or overflow-y (for vertical) property to
"scroll"if enabled, or clears the property if disabled.Specified by:
internalForceScrollbarin classScrollbarBundleParameters:
enable-trueif the overflow property should be set,falseotherwise.
-
getDirection
public ScrollbarBundle.Direction getDirection()Description copied from class:
ScrollbarBundleReturns the scroll direction of this scrollbar bundle.
Specified by:
getDirectionin classScrollbarBundleReturns:
the scroll direction of this scrollbar bundle
-
-