Package snap.view

Class Scroller

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.Scroller

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable, ViewHost

public class Scroller
extends ParentView
implements ViewHost

A class that can scroll a child view.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	Content_Prop
static final String	ScrollHeight_Prop
static final String	ScrollWidth_Prop
static final String	ScrollX_Prop
static final String	ScrollY_Prop

Fields inherited from class snap.view.ParentView

_children, Child_Prop, NeedsLayout_Prop

Fields inherited from class snap.view.View

_align, _borderRadius, _effect, _font, _margin, _padding, _repaintRect, _showing, _spacing, _vertical, Action, Align_Prop, Border_Prop, BorderRadius_Prop, Clip_Prop, Cursor_Prop, DEFAULT_ALIGN, DEFAULT_MARGIN, DEFAULT_PADDING, DEFAULT_SPACING, 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, Padding_Prop, Paintable_Prop, Parent_Prop, Pickable_Prop, PrefHeight_Prop, PrefWidth_Prop, Rotate_Prop, ScaleX_Prop, ScaleY_Prop, Scroll, Showing_Prop, Spacing_Prop, Text_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
Scroller()	Creates a new Scroller.

Method Summary

Modifier and Type	Method	Description
void	addGuest(View aChild, int anIndex)	ViewHost method: Override to set content.
View	getContent()	Returns the content.
protected Size	getContentPrefSize()	Returns preferred size of content view in Scroller.
View	getGuest(int anIndex)	ViewHost method: Override to return content (and complain if index beyond 0).
int	getGuestCount()	ViewHost method: Override to return 1 if content is present.
protected double	getMinHeightImpl()	Calculates the minimum height.
protected double	getMinWidthImpl()	Calculates the minimum width.
protected double	getPrefHeightImpl(double aW)	Calculates the preferred height.
protected double	getPrefWidthImpl(double aH)	Calculates the preferred width.
Object	getPropValue(String aPropName)	Override for Scroller properties.
double	getScrollHeight()	Returns the height of the content being scrolled.
double	getScrollLimitX()	Returns the maximum possible horizontal offset.
double	getScrollLimitY()	Returns the maximum possible vertical offset.
double	getScrollRatioX()	Returns the ratio of ScrollX to ScrollXMax.
double	getScrollRatioY()	Returns the ratio of ScrollY to ScrollYMax.
double	getScrollWidth()	Returns the width of the content being scrolled.
double	getScrollX()	Returns the horizontal offset into content.
double	getScrollY()	Returns the vertical offset into content.
boolean	isFillHeight()	Returns whether this scroller fits content to its height.
boolean	isFillWidth()	Returns whether this scroller fits content to its width.
protected void	layoutImpl()	Override to layout children.
void	processEvent(ViewEvent anEvent)	Handle events.
View	removeGuest(int anIndex)	ViewHost method: Override to clear content (and complain if index beyond 0).
void	scrollToVisible(Shape aShape)	Called to scroll the given shape in this node coords to visible.
void	setContent(View aView)	Sets the content.
void	setFillHeight(boolean aValue)	Sets whether this scroller fits content to its height.
void	setFillWidth(boolean aValue)	Sets whether this scroller fits content to its width.
void	setPropValue(String aPropName, Object aValue)	Override for Scroller properties.
protected void	setScrollHeight(double aValue)	Sets the height of the content being scrolled.
void	setScrollRatioX(double aValue)	Sets ScrollX from the given ratio of ScrollY to ScrollYMax.
void	setScrollRatioY(double aValue)	Sets ScrollY from the given ratio of ScrollY to ScrollYMax.
protected void	setScrollWidth(double aValue)	Sets the width of the content being scrolled.
void	setScrollX(double aValue)	Sets the horizontal offset into content.
void	setScrollY(double aValue)	Sets the vertical offset into content.

Methods inherited from class snap.view.ParentView

addChild, addChild, addDeepChangeListener, childDidDeepChange, childDidPropChange, fromXML, fromXMLChildren, fromXMLView, getChild, getChildAt, getChildAt, getChildCount, getChildCountManaged, getChildForClass, getChildForName, getChildLast, getChildren, getChildrenForClass, getChildrenInPaintOrder, getChildrenManaged, getFocusNext, getFocusPrev, getViewList, getViewProxy, indexOfChild, initProps, intersectsShape, isInLayout, isNeedsLayout, isNeedsLayoutDeep, isNeedsRepaintDeep, layout, layoutDeep, layoutDeepImpl, layoutFloatingViews, paintAbove, paintAll, paintChildren, parentFontChanged, processPropChange, relayout, removeChild, removeChild, removeChildren, removeDeepChangeListener, setChildren, setFont, setNeedsLayout, setNeedsLayoutDeep, setNeedsRepaintDeep, setOwner, setOwnerChildren, setShowing, themeChanged, toXML, toXMLChildren, toXMLView

Methods inherited from class snap.view.View

addBinding, addEventFilter, addEventHandler, clone, contains, contains, containsShape, createActionEvent, disableEvents, enableEvents, fireActionEvent, getAlign, getAlignX, getAlignY, getAnim, getAnimCleared, getAnimTimeDeep, getBestHeight, getBestSize, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBorder, getBorderRadius, getBounds, getBoundsLocal, getBoundsParent, getBoundsShape, getBoundsShapeParent, getClip, getClipAll, getClipAllBounds, getClipBounds, getClippedRect, getCursor, getDefaultBorder, getDefaultFill, 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, getMinSize, getMinWidth, getName, getOpacity, getOpacityAll, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefSize, getPrefWidth, getPrefWidth, getProp, getPropDefault, getProps, getRealClassName, getRepaintRect, getRepaintRectExpanded, getRootView, getRotate, getScale, getScaleX, getScaleY, getSize, getSpacing, getText, getToolTip, getToolTip, getTransX, getTransY, getUpdater, getValuePropName, getVisRect, getWidth, getWindow, getX, getXY, getY, indexInHost, indexInParent, isActionable, isAncestor, 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, isShowing, isToolTipEnabled, isVertical, isVisible, localToParent, localToParent, localToParent, localToParent, localToScreen, paintBack, paintFront, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEventAll, processEventFilters, processEventHandlers, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, runDelayed, runIntervals, runLater, setActionable, setAlign, setAlignX, setAlignY, setAnimProps, setAnimString, setAnimTimeDeep, setBorder, setBorder, setBorderRadius, setBounds, setBounds, setBoundsLocal, setClip, setClipToBounds, setCursor, setDisabled, setEffect, setEnabled, setFill, setFocusable, setFocused, setFocusKeysEnabled, setFocusPainted, setFocusWhenPressed, setGrowHeight, setGrowWidth, setHeight, setLean, setLeanX, setLeanY, setManaged, setMargin, setMargin, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth, setName, setOpacity, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setRealClassName, setRotate, setScale, setScaleX, setScaleY, setSize, setSize, setSizeLocal, setSizeToBestSize, setSizeToPrefSize, setSpacing, setText, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setVisible, setWidth, setX, setXY, setXYLocal, setY, stopAnimDeep, stopIntervals, toStringProps

Methods inherited from class snap.props.PropObject

addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, getPropsString, isPropDefault, removePropChangeListener, removePropChangeListener, setPropsString, setPropValues, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface snap.view.ViewHost

addGuest, getGuests, removeGuest

Field Details

Content_Prop

public static final String Content_Prop

See Also:

• Constant Field Values

ScrollX_Prop

public static final String ScrollX_Prop

See Also:

• Constant Field Values

ScrollY_Prop

public static final String ScrollY_Prop

See Also:

• Constant Field Values

ScrollWidth_Prop

public static final String ScrollWidth_Prop

See Also:

• Constant Field Values

ScrollHeight_Prop

public static final String ScrollHeight_Prop

See Also:

• Constant Field Values

Constructor Details

Scroller

public Scroller()

Creates a new Scroller.

Method Details

getContent

public View getContent()

Returns the content.

setContent

public void setContent(View aView)

Sets the content.

isFillWidth

public boolean isFillWidth()

Returns whether this scroller fits content to its width.

setFillWidth

public void setFillWidth(boolean aValue)

Sets whether this scroller fits content to its width.

isFillHeight

public boolean isFillHeight()

Returns whether this scroller fits content to its height.

setFillHeight

public void setFillHeight(boolean aValue)

Sets whether this scroller fits content to its height.

getScrollX

public double getScrollX()

Returns the horizontal offset into content.

setScrollX

public void setScrollX(double aValue)

Sets the horizontal offset into content.

getScrollY

public double getScrollY()

Returns the vertical offset into content.

setScrollY

public void setScrollY(double aValue)

Sets the vertical offset into content.

getScrollWidth

public double getScrollWidth()

Returns the width of the content being scrolled.

setScrollWidth

protected void setScrollWidth(double aValue)

Sets the width of the content being scrolled.

getScrollHeight

public double getScrollHeight()

Returns the height of the content being scrolled.

setScrollHeight

protected void setScrollHeight(double aValue)

Sets the height of the content being scrolled.

getScrollLimitX

public double getScrollLimitX()

Returns the maximum possible horizontal offset.

getScrollLimitY

public double getScrollLimitY()

Returns the maximum possible vertical offset.

getScrollRatioX

public double getScrollRatioX()

Returns the ratio of ScrollX to ScrollXMax.

setScrollRatioX

public void setScrollRatioX(double aValue)

Sets ScrollX from the given ratio of ScrollY to ScrollYMax.

getScrollRatioY

public double getScrollRatioY()

Returns the ratio of ScrollY to ScrollYMax.

setScrollRatioY

public void setScrollRatioY(double aValue)

Sets ScrollY from the given ratio of ScrollY to ScrollYMax.

getContentPrefSize

protected Size getContentPrefSize()

Returns preferred size of content view in Scroller.

scrollToVisible

public void scrollToVisible(Shape aShape)

Called to scroll the given shape in this node coords to visible.

Overrides:

scrollToVisible in class View

getGuestCount

public int getGuestCount()

ViewHost method: Override to return 1 if content is present.

Specified by:

getGuestCount in interface ViewHost

getGuest

public View getGuest(int anIndex)

ViewHost method: Override to return content (and complain if index beyond 0).

Specified by:

getGuest in interface ViewHost

addGuest

public void addGuest(View aChild,
 int anIndex)

ViewHost method: Override to set content.

Specified by:

addGuest in interface ViewHost

removeGuest

public View removeGuest(int anIndex)

ViewHost method: Override to clear content (and complain if index beyond 0).

Specified by:

removeGuest in interface ViewHost

getMinWidthImpl

protected double getMinWidthImpl()

Calculates the minimum width.

Overrides:

getMinWidthImpl in class View

getMinHeightImpl

protected double getMinHeightImpl()

Calculates the minimum height.

Overrides:

getMinHeightImpl in class View

getPrefWidthImpl

protected double getPrefWidthImpl(double aH)

Calculates the preferred width.

Overrides:

getPrefWidthImpl in class View

getPrefHeightImpl

protected double getPrefHeightImpl(double aW)

Calculates the preferred height.

Overrides:

getPrefHeightImpl in class View

layoutImpl

protected void layoutImpl()

Override to layout children.

Overrides:

layoutImpl in class ParentView

processEvent

public void processEvent(ViewEvent anEvent)

Handle events.

Overrides:

processEvent in class View

getPropValue

public Object getPropValue(String aPropName)

Override for Scroller properties.

Overrides:

getPropValue in class ParentView

setPropValue

public void setPropValue(String aPropName,
 Object aValue)

Override for Scroller properties.

Overrides:

setPropValue in class ParentView