Package com.vaadin.client.widget.escalator

Class ScrollbarBundle.HorizontalScrollbarBundle

java.lang.Object

com.vaadin.client.widget.escalator.ScrollbarBundle

com.vaadin.client.widget.escalator.ScrollbarBundle.HorizontalScrollbarBundle

All Implemented Interfaces:

DeferredWorker

Enclosing class:

ScrollbarBundle

public static final class ScrollbarBundle.HorizontalScrollbarBundle
extends ScrollbarBundle

A representation of a single horizontal scrollbar.

See Also:

ScrollbarBundle.getElement()

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
HorizontalScrollbarBundle()

Method Summary

Modifier and Type	Method	Description
ScrollbarBundle.Direction	getDirection()	Returns the scroll direction of this scrollbar bundle.
protected void	internalForceScrollbar(boolean enable)	Sets the overflow-x (for horizontal) or overflow-y (for vertical) property to "scroll" if enabled, or clears the property if disabled.
String	internalGetOffsetSize()	Returns the width (for horizontal) or height (for vertical) css property for the root element.
protected String	internalGetScrollbarThickness()	Gets the scrollbar's thickness as defined in the DOM.
protected int	internalGetScrollPos()	Retrieves the element's scroll position (scrollTop or scrollLeft).
protected String	internalGetScrollSize()	Returns the width (for horizontal) or height (for vertical) css property for the scroll size element.
protected void	internalSetOffsetSize(double px)	Modifies root's dimensions in the axis the scrollbar is representing.
protected void	internalSetScrollbarThickness(double px)	Modifies scrollSizeElement's dimensions in the opposite axis to what the scrollbar is representing.
protected void	internalSetScrollPos(int px)	Modifies the element's scroll position (scrollTop or scrollLeft).
protected void	internalSetScrollSize(double px)	Modifies scrollSizeElement's dimensions in such a way that the scrollbar is able to scroll a certain number of pixels in the axis it is representing.
void	setStylePrimaryName(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

Methods inherited from class java.lang.Object

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

Constructor Detail

HorizontalScrollbarBundle

public HorizontalScrollbarBundle()

Method Detail

setStylePrimaryName

public void setStylePrimaryName(String primaryStyleName)

Description copied from class: ScrollbarBundle

Sets the primary style name.

Overrides:

setStylePrimaryName in class ScrollbarBundle

Parameters:

primaryStyleName - The primary style name to use

internalSetScrollPos

protected void internalSetScrollPos(int px)

Description copied from class: ScrollbarBundle

Modifies 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:

internalSetScrollPos in class ScrollbarBundle

Parameters:

px - integer pixel value to scroll to

internalGetScrollPos

protected int internalGetScrollPos()

Description copied from class: ScrollbarBundle

Retrieves 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:

internalGetScrollPos in class ScrollbarBundle

Returns:

integer pixel value of the scroll position

internalSetScrollSize

protected void internalSetScrollSize(double px)

Description copied from class: ScrollbarBundle

Modifies scrollSizeElement's dimensions in such a way that the scrollbar is able to scroll a certain number of pixels in the axis it is representing.

Specified by:

internalSetScrollSize in class ScrollbarBundle

Parameters:

px - the new size of ScrollbarBundle.scrollSizeElement in the dimension this scrollbar is representing

internalGetScrollSize

protected String internalGetScrollSize()

Description copied from class: ScrollbarBundle

Returns the width (for horizontal) or height (for vertical) css property for the scroll size element.

Specified by:

internalGetScrollSize in class ScrollbarBundle

Returns:

the relevant size property based on orientation

internalSetOffsetSize

protected void internalSetOffsetSize(double px)

Description copied from class: ScrollbarBundle

Modifies root's dimensions in the axis the scrollbar is representing.

Specified by:

internalSetOffsetSize in class ScrollbarBundle

Parameters:

px - the new size of ScrollbarBundle.root in the dimension this scrollbar is representing

internalGetOffsetSize

public String internalGetOffsetSize()

Description copied from class: ScrollbarBundle

Returns the width (for horizontal) or height (for vertical) css property for the root element.

Specified by:

internalGetOffsetSize in class ScrollbarBundle

Returns:

the relevant size property based on orientation

internalSetScrollbarThickness

protected void internalSetScrollbarThickness(double px)

Description copied from class: ScrollbarBundle

Modifies scrollSizeElement's dimensions in the opposite axis to what the scrollbar is representing.

Specified by:

internalSetScrollbarThickness in class ScrollbarBundle

Parameters:

px - the dimension that ScrollbarBundle.scrollSizeElement should take in the opposite axis to what the scrollbar is representing

internalGetScrollbarThickness

protected String internalGetScrollbarThickness()

Description copied from class: ScrollbarBundle

Gets the scrollbar's thickness as defined in the DOM.

Specified by:

internalGetScrollbarThickness in class ScrollbarBundle

Returns:

the scrollbar's thickness as defined in the DOM, in pixels

internalForceScrollbar

protected void internalForceScrollbar(boolean enable)

Description copied from class: ScrollbarBundle

Sets the overflow-x (for horizontal) or overflow-y (for vertical) property to "scroll" if enabled, or clears the property if disabled.

Specified by:

internalForceScrollbar in class ScrollbarBundle

Parameters:

enable - true if the overflow property should be set, false otherwise.

getDirection

public ScrollbarBundle.Direction getDirection()

Description copied from class: ScrollbarBundle

Returns the scroll direction of this scrollbar bundle.

Specified by:

getDirection in class ScrollbarBundle

Returns:

the scroll direction of this scrollbar bundle