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
A View for scrolling other views.
-
Nested Class Summary
Nested classes/interfaces inherited from class snap.view.View
View.Overflow
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Fields inherited from class snap.view.ParentView
_children, Children_Prop, NeedsLayout_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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
ViewHost method: Override to send to Scroller.void
fromXMLView
(XMLArchiver anArchiver, XMLElement anElement) XML unarchival.int
Returns the scroll bar size.Returns the content.getGuest
(int anIndex) ViewHost method: Override to send to Scroller.int
ViewHost method: Override to send to Scroller.getHBar()
Returns the Horizontal ScrollBar.protected double
Calculates the minimum height.protected double
Calculates the minimum width.protected double
getPrefHeightImpl
(double aW) Calculates the preferred height.protected double
getPrefWidthImpl
(double aH) Calculates the preferred width.getPropValue
(String aPropName) Override to support props for this class.Returns the view that handles scrolling.Returns whether to show horizontal scroll bar (null means 'as-needed').Returns whether to show vertical scroll bar (null means 'as-needed').getVBar()
Returns the vertical ScrollBar.protected void
Handle ScrollBar property changes.protected void
Handle Scroller property changes.protected void
Override to support props for this class.boolean
Returns whether this ScrollView fits content to its height.boolean
Returns whether this ScrollView fits content to its width.boolean
Returns whether HBar is showing.boolean
Returns whether VBar is showing.protected void
Override to layout children.protected void
Override to paint content border.removeGuest
(int anIndex) ViewHost method: Override to send to Scroller.void
setBarSize
(int aValue) Sets the scroll bar size.void
setBorderRadius
(double aValue) Override to propagate to Scroller and ScrollBars.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
setPropValue
(String aPropName, Object aValue) Override to support props for this class.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.toXMLView
(XMLArchiver anArchiver) XML archival.protected boolean
Called to update whether ScrollBars are showing.Methods inherited from class snap.view.ParentView
addChild, addChild, addDeepChangeListener, childDidDeepChange, childDidPropChange, fromXML, fromXMLChildren, getChild, getChildAtXY, getChildCount, getChildCountManaged, getChildForClass, getChildForName, getChildLast, getChildren, getChildrenArray, getChildrenForClass, getChildrenInPaintOrder, getChildrenManaged, getFocusNext, getFocusPrev, getViewProxy, indexOfChild, intersectsShape, isInLayout, isNeedsLayout, isNeedsLayoutDeep, isNeedsRepaintDeep, layout, layoutDeep, layoutDeepImpl, layoutFloatingViews, paintChildren, parentFontChanged, processPropChange, relayout, removeChild, removeChild, removeChildren, removeDeepChangeListener, setChildren, setFont, setNeedsLayout, setNeedsLayoutDeep, setNeedsRepaintDeep, setOwner, setOwnerChildren, setShowing, themeChanged, toXML, toXMLChildren
Methods inherited from class snap.view.View
addEventFilter, addEventHandler, clone, contains, contains, containsShape, createActionEvent, disableEvents, enableEvents, fireActionEvent, 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, getMinSize, getMinWidth, getName, getOpacity, getOpacityAll, getOverflow, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefSize, getPrefWidth, getPrefWidth, getProp, getPropDefault, getProps, 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, initStyleProps, 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, paintBack, paintFront, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEvent, processEventAll, processEventFilters, processEventHandlers, relayoutParent, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, runDelayed, runIntervals, runLater, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, setAnimString, setAnimTimeDeep, setBorder, setBorder, setBounds, setBounds, setBoundsLocal, 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, setOverflow, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setRotate, setRuntimeClassName, setScale, setScaleX, setScaleY, setSize, setSize, setSizeLocal, setSizeToBestSize, setSizeToPrefSize, setSpacing, setText, setTextColor, 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, processArchivedNode, processUnarchivedNode, 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, setGuests
-
Field Details
-
Content_Prop
- See Also:
-
FillWidth_Prop
- See Also:
-
FillHeight_Prop
- See Also:
-
ShowHBar_Prop
- See Also:
-
ShowVBar_Prop
- See Also:
-
BarSize_Prop
- See Also:
-
HBarShowing_Prop
- See Also:
-
VBarShowing_Prop
- See Also:
-
-
Constructor Details
-
ScrollView
public ScrollView()Constructor. -
ScrollView
Constructor for given view.
-
-
Method Details
-
getContent
Returns the content. -
setContent
Sets the content. -
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. -
getGuestCount
public int getGuestCount()ViewHost method: Override to send to Scroller.- Specified by:
getGuestCount
in interfaceViewHost
-
getGuest
ViewHost method: Override to send to Scroller. -
addGuest
ViewHost method: Override to send to Scroller. -
removeGuest
ViewHost method: Override to send to Scroller.- Specified by:
removeGuest
in interfaceViewHost
-
getScroller
Returns the view that handles scrolling. -
getHBar
Returns the Horizontal ScrollBar. -
getVBar
Returns the vertical ScrollBar. -
getShowHBar
Returns whether to show horizontal scroll bar (null means 'as-needed'). -
setShowHBar
Sets whether to show horizontal scroll bar (null means 'as-needed'). -
getShowVBar
Returns whether to show vertical scroll bar (null means 'as-needed'). -
setShowVBar
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. -
paintAll
Override to paint content border.- Overrides:
paintAll
in classParentView
-
getMinWidthImpl
protected double getMinWidthImpl()Calculates the minimum width.- Overrides:
getMinWidthImpl
in classView
-
getMinHeightImpl
protected double getMinHeightImpl()Calculates the minimum height.- Overrides:
getMinHeightImpl
in classView
-
getPrefWidthImpl
protected double getPrefWidthImpl(double aH) Calculates the preferred width.- Overrides:
getPrefWidthImpl
in classView
-
getPrefHeightImpl
protected double getPrefHeightImpl(double aW) Calculates the preferred height.- Overrides:
getPrefHeightImpl
in classView
-
layoutImpl
protected void layoutImpl()Override to layout children.- Overrides:
layoutImpl
in classParentView
-
updateScrollBarsShowing
protected boolean updateScrollBarsShowing()Called to update whether ScrollBars are showing. Returns true if any changes. -
handleScrollerPropChange
Handle Scroller property changes. -
handleScrollBarPropChange
Handle ScrollBar property changes. -
setBorderRadius
public void setBorderRadius(double aValue) Override to propagate to Scroller and ScrollBars.- Overrides:
setBorderRadius
in classView
-
initProps
Override to support props for this class.- Overrides:
initProps
in classParentView
-
getPropValue
Override to support props for this class.- Overrides:
getPropValue
in classParentView
-
setPropValue
Override to support props for this class.- Overrides:
setPropValue
in classParentView
-
toXMLView
XML archival.- Overrides:
toXMLView
in classParentView
-
fromXMLView
XML unarchival.- Overrides:
fromXMLView
in classParentView
-