Package snap.view

Class ScrollBar

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ScrollBar

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

public class ScrollBar
extends View

A ScrollBar for ScrollView.

Nested Class Summary

Nested classes/interfaces inherited from class snap.view.View

View.Overflow

Field Summary

Fields

Modifier and Type	Field	Description
static final String	Scroll_Prop

Fields inherited from class snap.view.View

_align, _border, _borderRadius, _effect, _fill, _font, _margin, _padding, _repaintRect, _showing, _spacing, _vertical, Action, Align_Prop, Border_Prop, BorderRadius_Prop, Cursor_Prop, Disabled_Prop, DragEvents, Effect_Prop, Fill_Prop, Focusable_Prop, Focused_Prop, FocusWhenPressed_Prop, Font_Prop, GrowHeight_Prop, GrowWidth_Prop, Height_Prop, KeyEvents, KeyPress, KeyRelease, KeyType, LeanX_Prop, LeanY_Prop, Managed_Prop, Margin_Prop, MaxHeight_Prop, MaxWidth_Prop, MinHeight_Prop, MinWidth_Prop, MouseDrag, MouseEnter, MouseEvents, MouseExit, MouseMove, MousePress, MouseRelease, Name_Prop, Opacity_Prop, Overflow_Prop, Padding_Prop, Paintable_Prop, Parent_Prop, Pickable_Prop, PrefHeight_Prop, PrefWidth_Prop, Rotate_Prop, RuntimeClassName_Prop, ScaleX_Prop, ScaleY_Prop, Scroll, Showing_Prop, Spacing_Prop, Text_Prop, TextColor_Prop, ToolTip_Prop, TransX_Prop, TransY_Prop, Vertical_Prop, Visible_Prop, Width_Prop, X_Prop, Y_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
ScrollBar()	Constructor.

Method Summary

Modifier and Type	Method	Description
double	getContentSize()	Returns the size of the content being scrolled.
double	getScroll()	Returns the offset into ContentSize.
double	getScrollerSize()	Returns the size of the scroller showing content.
double	getScrollMax()	Returns the maximum value of scroll (scroll size - view size)
double	getScrollRatio()	Returns the ratio of current scroll to maximum scroll (0-1).
Rect	getThumbBounds()	Returns the thumb rect.
protected void	paintFront(Painter aPntr)	Paints the thumb.
protected void	processEvent(ViewEvent anEvent)	Handle events.
void	setContentSize(double aValue)	Sets the size of the content being scrolled.
void	setScroll(double aValue)	Sets the offset into ContentSize.
void	setScrollerSize(double aValue)	Sets the size of the scroller showing content.
void	setScrollRatio(double aValue)	Sets the ratio of current scroll to maximum scroll (0-1).

Methods inherited from class snap.view.View

addEventFilter, addEventHandler, clone, contains, contains, containsShape, createActionEvent, disableEvents, enableEvents, fireActionEvent, fromXML, getAlign, getAlignX, getAlignY, getAnim, getAnimCleared, getAnimTimeDeep, getBestHeight, getBestSize, getBestWidth, getBorder, getBorderRadius, getBounds, getBoundsLocal, getBoundsParent, getBoundsShape, getBoundsShapeParent, getClip, getClipAll, getClipBounds, getClipBoundsAll, getCursor, getDefaultFont, getEffect, getEnv, getEventAdapter, getFill, getFillColor, getFocusNext, getFocusPrev, getFont, getHeight, getHost, getInsetsAll, getLean, getLeanX, getLeanY, getLocalToParent, getLocalToParent, getMargin, getMaxHeight, getMaxSize, getMaxWidth, getMaxX, getMaxY, getMidX, getMidY, getMinHeight, getMinHeightImpl, getMinSize, getMinWidth, getMinWidthImpl, getName, getOpacity, getOpacityAll, getOverflow, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefHeightImpl, getPrefSize, getPrefWidth, getPrefWidth, getPrefWidthImpl, getProp, getPropDefault, getProps, getPropValue, getRepaintRect, getRepaintRectExpanded, getRootView, getRotate, getRuntimeClassName, getScale, getScaleX, getScaleY, getSize, getSpacing, getText, getTextColor, getToolTip, getToolTip, getTransX, getTransY, getUpdater, getValuePropName, getVisibleBounds, getWidth, getWindow, getX, getXY, getY, indexInHost, indexInParent, initProps, initStyleProps, intersectsShape, isActionable, isAncestor, isAnimActive, isClipToBounds, isDisabled, isEnabled, isFocusable, isFocused, isFocusKeysEnabled, isFocusPainted, isFocusWhenPressed, isFontSet, isGrowHeight, isGrowWidth, isGuest, isHorizontal, isLocalToParentSimple, isManaged, isManagedVisible, isMaxHeightSet, isMaxWidthSet, isMinHeightSet, isMinWidthSet, isMouseDown, isMouseOver, isNeedsRepaint, isPaintable, isPickable, isPickableVisible, isPrefHeightSet, isPrefWidthSet, isPropDefault, isShowing, isToolTipEnabled, isVertical, isVisible, localToParent, localToParent, localToParent, localToParent, localToScreen, paintAbove, paintAll, paintBack, paintChildren, parentFontChanged, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEventAll, processEventFilters, processEventHandlers, relayout, relayoutParent, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, runDelayed, runIntervals, runLater, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, setAnimString, setAnimTimeDeep, setBorder, setBorder, setBorderRadius, setBounds, setBounds, setBoundsLocal, setClipToBounds, setCursor, setDisabled, setEffect, setEnabled, setFill, setFocusable, setFocused, setFocusKeysEnabled, setFocusPainted, setFocusWhenPressed, setFont, setGrowHeight, setGrowWidth, setHeight, setLean, setLeanX, setLeanY, setManaged, setMargin, setMargin, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth, setName, setOpacity, setOverflow, setOwner, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setPropValue, setRotate, setRuntimeClassName, setScale, setScaleX, setScaleY, setShowing, setSize, setSize, setSizeLocal, setSizeToBestSize, setSizeToPrefSize, setSpacing, setText, setTextColor, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setVisible, setWidth, setX, setXY, setXYLocal, setY, stopAnimDeep, stopIntervals, themeChanged, toStringProps, toXML

Methods inherited from class snap.props.PropObject

addDeepChangeListener, addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, getPropsString, processArchivedNode, processPropChange, processUnarchivedNode, removeDeepChangeListener, removePropChangeListener, removePropChangeListener, setPropsString, setPropValues, toString

Methods inherited from class java.lang.Object

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

Field Details

Scroll_Prop

public static final String Scroll_Prop

See Also:

• Constant Field Values

Constructor Details

ScrollBar

public ScrollBar()

Constructor.

Method Details

getScroll

public double getScroll()

Returns the offset into ContentSize.

setScroll

public void setScroll(double aValue)

Sets the offset into ContentSize.

getScrollMax

public double getScrollMax()

Returns the maximum value of scroll (scroll size - view size)

getScrollerSize

public double getScrollerSize()

Returns the size of the scroller showing content.

setScrollerSize

public void setScrollerSize(double aValue)

Sets the size of the scroller showing content.

getContentSize

public double getContentSize()

Returns the size of the content being scrolled.

setContentSize

public void setContentSize(double aValue)

Sets the size of the content being scrolled.

getScrollRatio

public double getScrollRatio()

Returns the ratio of current scroll to maximum scroll (0-1).

setScrollRatio

public void setScrollRatio(double aValue)

Sets the ratio of current scroll to maximum scroll (0-1).

getThumbBounds

public Rect getThumbBounds()

Returns the thumb rect.

processEvent

protected void processEvent(ViewEvent anEvent)

Handle events.

Overrides:

processEvent in class View

paintFront

protected void paintFront(Painter aPntr)

Paints the thumb.

Overrides:

paintFront in class View