Package snap.view

Class ScrollView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.ScrollView

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable, ViewHost

public class ScrollView
extends ParentView
implements ViewHost

A View for scrolling other views.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BarSize_Prop
static final Border	DEFAULT_SCROLL_VIEW_BORDER
static final String	HBarShowing_Prop
static final String	ShowHBar_Prop
static final String	ShowVBar_Prop
static final String	VBarShowing_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
ScrollView()	Constructor.
ScrollView(View aView)	Constructor for given view.

Method Summary

Modifier and Type	Method	Description
void	addGuest(View aChild, int anIndex)	ViewHost method: Override to send to Scroller.
void	fromXMLView(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
int	getBarSize()	Returns the scroll bar size.
View	getContent()	Returns the content.
Border	getDefaultBorder()	Returns the default border.
View	getGuest(int anIndex)	ViewHost method: Override to send to Scroller.
int	getGuestCount()	ViewHost method: Override to send to Scroller.
ScrollBar	getHBar()	Returns the Horizontal ScrollBar.
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.
Scroller	getScroller()	Returns the view that handles scrolling.
Boolean	getShowHBar()	Returns whether to show horizontal scroll bar (null means 'as-needed').
Boolean	getShowVBar()	Returns whether to show vertical scroll bar (null means 'as-needed').
ScrollBar	getVBar()	Returns the vertical ScrollBar.
boolean	isFillHeight()	Returns whether this ScrollView fits content to its height.
boolean	isFillWidth()	Returns whether this ScrollView fits content to its width.
boolean	isHBarShowing()	Returns whether HBar is showing.
boolean	isVBarShowing()	Returns whether VBar is showing.
protected void	layoutImpl()	Override to layout children.
View	removeGuest(int anIndex)	ViewHost method: Override to send to Scroller.
void	scrollBarDidPropChange(PropChange aPC)	Handle ScrollBar property changes.
protected void	scrollerDidPropChange(PropChange anEvent)	Handle Scroller property changes.
void	setBarSize(int aValue)	Sets the scroll bar size.
void	setContent(View aView)	Sets the content.
void	setFillHeight(boolean aValue)	Sets whether this ScrollView fits content to its height.
void	setFillWidth(boolean aValue)	Sets whether this ScrollView fits content to its width.
protected void	setHBarShowing(boolean aValue)	Sets whether HBar is showing.
void	setShowHBar(Boolean aValue)	Sets whether to show horizontal scroll bar (null means 'as-needed').
void	setShowVBar(Boolean aValue)	Returns whether to show vertical scroll bar (null means 'as-needed').
protected void	setVBarShowing(boolean aValue)	Sets whether VBar is showing.
XMLElement	toXMLView(XMLArchiver anArchiver)	XML archival.
protected boolean	updateScrollBarsShowing()	Called to update whether ScrollBars are showing.

Methods inherited from class snap.view.ParentView

addChild, addChild, addDeepChangeListener, childDidDeepChange, childDidPropChange, fromXML, fromXMLChildren, getChild, getChildAt, getChildAt, getChildCount, getChildCountManaged, getChildForClass, getChildForName, getChildLast, getChildren, getChildrenForClass, getChildrenInPaintOrder, getChildrenManaged, getFocusNext, getFocusPrev, getPropValue, 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, setPropValue, setShowing, themeChanged, toXML, toXMLChildren

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, 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, processEvent, processEventAll, processEventFilters, processEventHandlers, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, runDelayed, runIntervals, runLater, scrollToVisible, 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

DEFAULT_SCROLL_VIEW_BORDER

public static final Border DEFAULT_SCROLL_VIEW_BORDER

ShowHBar_Prop

public static final String ShowHBar_Prop

See Also:

• Constant Field Values

ShowVBar_Prop

public static final String ShowVBar_Prop

See Also:

• Constant Field Values

HBarShowing_Prop

public static final String HBarShowing_Prop

See Also:

• Constant Field Values

VBarShowing_Prop

public static final String VBarShowing_Prop

See Also:

• Constant Field Values

BarSize_Prop

public static final String BarSize_Prop

See Also:

• Constant Field Values

Constructor Details

ScrollView

public ScrollView()

Constructor.

ScrollView

public ScrollView(View aView)

Constructor for given view.

Method Details

getContent

public View getContent()

Returns the content.

setContent

public void setContent(View aView)

Sets the content.

getGuestCount

public int getGuestCount()

ViewHost method: Override to send to Scroller.

Specified by:

getGuestCount in interface ViewHost

getGuest

public View getGuest(int anIndex)

ViewHost method: Override to send to Scroller.

Specified by:

getGuest in interface ViewHost

addGuest

public void addGuest(View aChild,
 int anIndex)

ViewHost method: Override to send to Scroller.

Specified by:

addGuest in interface ViewHost

removeGuest

public View removeGuest(int anIndex)

ViewHost method: Override to send to Scroller.

Specified by:

removeGuest in interface ViewHost

getScroller

public Scroller getScroller()

Returns the view that handles scrolling.

getHBar

public ScrollBar getHBar()

Returns the Horizontal ScrollBar.

getVBar

public ScrollBar getVBar()

Returns the vertical ScrollBar.

getShowHBar

public Boolean getShowHBar()

Returns whether to show horizontal scroll bar (null means 'as-needed').

setShowHBar

public void setShowHBar(Boolean aValue)

Sets whether to show horizontal scroll bar (null means 'as-needed').

getShowVBar

public Boolean getShowVBar()

Returns whether to show vertical scroll bar (null means 'as-needed').

setShowVBar

public void setShowVBar(Boolean aValue)

Returns whether to show vertical scroll bar (null means 'as-needed').

isHBarShowing

public boolean isHBarShowing()

Returns whether HBar is showing.

setHBarShowing

protected void setHBarShowing(boolean aValue)

Sets whether HBar is showing.

isVBarShowing

public boolean isVBarShowing()

Returns whether VBar is showing.

setVBarShowing

protected void setVBarShowing(boolean aValue)

Sets whether VBar is showing.

getBarSize

public int getBarSize()

Returns the scroll bar size.

setBarSize

public void setBarSize(int aValue)

Sets the scroll bar size.

isFillWidth

public boolean isFillWidth()

Returns whether this ScrollView fits content to its width.

setFillWidth

public void setFillWidth(boolean aValue)

Sets whether this ScrollView fits content to its width.

isFillHeight

public boolean isFillHeight()

Returns whether this ScrollView fits content to its height.

setFillHeight

public void setFillHeight(boolean aValue)

Sets whether this ScrollView fits content to its height.

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

updateScrollBarsShowing

protected boolean updateScrollBarsShowing()

Called to update whether ScrollBars are showing. Returns true if any changes.

getDefaultBorder

public Border getDefaultBorder()

Returns the default border.

Overrides:

getDefaultBorder in class View

scrollerDidPropChange

protected void scrollerDidPropChange(PropChange anEvent)

Handle Scroller property changes.

scrollBarDidPropChange

public void scrollBarDidPropChange(PropChange aPC)

Handle ScrollBar property changes.

toXMLView

public XMLElement toXMLView(XMLArchiver anArchiver)

XML archival.

Overrides:

toXMLView in class ParentView

fromXMLView

public void fromXMLView(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival.

Overrides:

fromXMLView in class ParentView