Package snap.view

Class ParentView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

Direct Known Subclasses:

ArrowView, BorderView, BoxView, BrowserView, ButtonBase, CameraView, ChildView, CollapseView, ComboBox, DocView, DrawerView, Label, ListArea, ListView, MenuBar, RootView, Scroller, ScrollGroup, ScrollView, Spinner, SplitView, TabBar, TableView, TabView, TextField, TextView, TitleView, Trackball, TransitionPane, TreeView, WindowView, WrapView

public class ParentView
extends View

A View subclass for views with children.

Field Summary

Fields

Modifier and Type	Field	Description
protected ViewList	_children
static final String	Child_Prop
static final String	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
ParentView()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addChild(View aChild)	Adds the given child to the end of this view's children list.
protected void	addChild(View aChild, int anIndex)	Adds the given child to this view's children list at the given index.
void	addDeepChangeListener(DeepChangeListener aDCL)	Override to add this view as change listener to children on first call.
protected void	childDidDeepChange(Object aLsnr, PropChange aPC)	Deep property change listener implementation to forward to this View's deep listeners.
protected void	childDidPropChange(PropChange aPC)	Property change listener implementation to forward changes on to deep listeners.
View	fromXML(XMLArchiver anArchiver, XMLElement anElement)	Override to break fromXML into fromXMLView and fromXMLChildren.
protected void	fromXMLChildren(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival for shape children.
protected void	fromXMLView(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival of basic view.
View	getChild(int anIndex)	Returns the child at the given index.
View	getChildAt(double aX, double aY)	Returns the child at given point.
View	getChildAt(Point aPnt)	Returns the child at given point.
int	getChildCount()	Returns the number of children associated with this view.
int	getChildCountManaged()	Returns the number of managed children.
<E extends View> E	getChildForClass(Class<E> aClass)	Returns the child for given component class.
View	getChildForName(String aName)	Returns the child with given name.
View	getChildLast()	Returns the last child of this view.
View[]	getChildren()	Returns the array of children associated with this view.
<E extends View> E[]	getChildrenForClass(Class<E> aClass)	Returns the children for given component class.
protected View[]	getChildrenInPaintOrder()	Returns the children in paint order.
View[]	getChildrenManaged()	Returns the managed children.
protected View	getFocusNext(View aChild)	Returns the next focus View after given view (null to return first).
protected View	getFocusPrev(View aChild)	Returns the next focus View after given view (null to return last).
Object	getPropValue(String aPropName)	Override to support props for this class.
ViewList	getViewList()	Returns the ViewList that holds children.
protected ViewProxy<?>	getViewProxy()	Returns a ViewProxy for this View.
int	indexOfChild(View aChild)	Returns the index of the given child in this view's children list.
protected void	initProps(PropSet aPropSet)	Override to support props for this class.
boolean	intersectsShape(Shape aShape)	Override to forward to children.
boolean	isInLayout()	Returns whether view is currently performing layout.
boolean	isNeedsLayout()	Returns whether needs layout.
boolean	isNeedsLayoutDeep()	Returns whether any children need layout.
boolean	isNeedsRepaintDeep()	Returns whether any children need repaint.
void	layout()	Override to layout children.
void	layoutDeep()	Lays out children deep.
protected void	layoutDeepImpl()	Lays out children deep.
protected void	layoutFloatingViews()	Called to layout floating children (those unmanaged with lean) according to their Lean, Grow and Margin.
protected void	layoutImpl()	Actual method to layout children.
protected void	paintAbove(Painter aPntr)	Paints above children.
protected void	paintAll(Painter aPntr)	Override to add call to paintChildren.
protected void	paintChildren(Painter aPntr)	Paint children.
protected void	parentFontChanged()	Override to forward to children that inherit font.
void	processPropChange(PropChange aPC, Object oldVal, Object newVal)	Override to handle ParentView changes.
void	relayout()	Override to really request layout from RootView.
protected View	removeChild(int anIndex)	Remove's the child at the given index from this view's children list.
protected int	removeChild(View aChild)	Removes the given child from this view's children list.
protected void	removeChildren()	Removes all children from this view (in reverse order).
void	removeDeepChangeListener(DeepChangeListener aDCL)	Override to remove this view as change listener to children when not needed.
protected void	setChildren(View... theChildren)	Sets children to given list.
void	setFont(Font aFont)	Override to propagate to children.
protected void	setNeedsLayout(boolean aVal)	Sets whether needs layout.
protected void	setNeedsLayoutDeep(boolean aVal)	Sets whether any children need layout.
protected void	setNeedsRepaintDeep(boolean aVal)	Sets whether any children need repaint.
void	setOwner(ViewOwner anOwner)	Override to send to children.
protected void	setOwnerChildren(ViewOwner anOwner)	Forwards setOwner() call to children.
void	setPropValue(String aPropName, Object aValue)	Override to support props for this class.
protected void	setShowing(boolean aValue)	Override to send to children.
protected void	themeChanged()	Called when ViewTheme changes.
XMLElement	toXML(XMLArchiver anArchiver)	Override to break toXML into toXMLView and toXMLChildren.
protected void	toXMLChildren(XMLArchiver anArchiver, XMLElement anElement)	XML archival of children.
protected XMLElement	toXMLView(XMLArchiver anArchiver)	XML Archival of basic view.

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, getMinHeightImpl, getMinSize, getMinWidth, getMinWidthImpl, getName, getOpacity, getOpacityAll, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefHeightImpl, getPrefSize, getPrefWidth, getPrefWidth, getPrefWidthImpl, 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

Field Details

_children

protected ViewList _children

Child_Prop

public static final String Child_Prop

See Also:

• Constant Field Values

NeedsLayout_Prop

public static final String NeedsLayout_Prop

See Also:

• Constant Field Values

Constructor Details

ParentView

public ParentView()

Constructor.

Method Details

getViewList

public ViewList getViewList()

Returns the ViewList that holds children.

getChildCount

public int getChildCount()

Returns the number of children associated with this view.

getChild

public View getChild(int anIndex)

Returns the child at the given index.

getChildren

public View[] getChildren()

Returns the array of children associated with this view.

addChild

protected void addChild(View aChild)

Adds the given child to the end of this view's children list.

addChild

protected void addChild(View aChild,
 int anIndex)

Adds the given child to this view's children list at the given index.

removeChild

protected View removeChild(int anIndex)

Remove's the child at the given index from this view's children list.

removeChild

protected int removeChild(View aChild)

Removes the given child from this view's children list.

removeChildren

protected void removeChildren()

Removes all children from this view (in reverse order).

setChildren

protected void setChildren(View... theChildren)

Sets children to given list.

getChildrenInPaintOrder

protected View[] getChildrenInPaintOrder()

Returns the children in paint order.

getChildForName

public View getChildForName(String aName)

Returns the child with given name.

indexOfChild

public int indexOfChild(View aChild)

Returns the index of the given child in this view's children list.

getChildLast

public View getChildLast()

Returns the last child of this view.

getChildForClass

public <E extends View> E getChildForClass(Class<E> aClass)

Returns the child for given component class.

getChildrenForClass

public <E extends View> E[] getChildrenForClass(Class<E> aClass)

Returns the children for given component class.

getChildAt

public View getChildAt(Point aPnt)

Returns the child at given point.

getChildAt

public View getChildAt(double aX,
 double aY)

Returns the child at given point.

getChildCountManaged

public int getChildCountManaged()

Returns the number of managed children.

getChildrenManaged

public View[] getChildrenManaged()

Returns the managed children.

getFocusNext

protected View getFocusNext(View aChild)

Returns the next focus View after given view (null to return first).

getFocusPrev

protected View getFocusPrev(View aChild)

Returns the next focus View after given view (null to return last).

setFont

public void setFont(Font aFont)

Override to propagate to children.

Overrides:

setFont in class View

parentFontChanged

protected void parentFontChanged()

Override to forward to children that inherit font.

Overrides:

parentFontChanged in class View

setShowing

protected void setShowing(boolean aValue)

Override to send to children.

Overrides:

setShowing in class View

setOwner

public void setOwner(ViewOwner anOwner)

Override to send to children.

Overrides:

setOwner in class View

setOwnerChildren

protected void setOwnerChildren(ViewOwner anOwner)

Forwards setOwner() call to children.

intersectsShape

public boolean intersectsShape(Shape aShape)

Override to forward to children.

Overrides:

intersectsShape in class View

paintAll

protected void paintAll(Painter aPntr)

Override to add call to paintChildren.

Overrides:

paintAll in class View

paintChildren

protected void paintChildren(Painter aPntr)

Paint children.

paintAbove

protected void paintAbove(Painter aPntr)

Paints above children.

isNeedsRepaintDeep

public boolean isNeedsRepaintDeep()

Returns whether any children need repaint.

setNeedsRepaintDeep

protected void setNeedsRepaintDeep(boolean aVal)

Sets whether any children need repaint.

relayout

public void relayout()

Override to really request layout from RootView.

Overrides:

relayout in class View

isNeedsLayout

public boolean isNeedsLayout()

Returns whether needs layout.

setNeedsLayout

protected void setNeedsLayout(boolean aVal)

Sets whether needs layout.

isNeedsLayoutDeep

public boolean isNeedsLayoutDeep()

Returns whether any children need layout.

setNeedsLayoutDeep

protected void setNeedsLayoutDeep(boolean aVal)

Sets whether any children need layout.

isInLayout

public boolean isInLayout()

Returns whether view is currently performing layout.

layout

public void layout()

Override to layout children.

layoutImpl

protected void layoutImpl()

Actual method to layout children.

layoutFloatingViews

protected void layoutFloatingViews()

Called to layout floating children (those unmanaged with lean) according to their Lean, Grow and Margin.

layoutDeep

public void layoutDeep()

Lays out children deep.

layoutDeepImpl

protected void layoutDeepImpl()

Lays out children deep.

getViewProxy

protected ViewProxy<?> getViewProxy()

Returns a ViewProxy for this View. Some classes already have this, but I'm hoping to do something really clever with this one day, like maybe caching PrefSize info.

processPropChange

public void processPropChange(PropChange aPC,
 Object oldVal,
 Object newVal)

Override to handle ParentView changes.

Specified by:

processPropChange in interface PropChange.DoChange

Overrides:

processPropChange in class PropObject

addDeepChangeListener

public void addDeepChangeListener(DeepChangeListener aDCL)

Override to add this view as change listener to children on first call.

Overrides:

addDeepChangeListener in class PropObject

removeDeepChangeListener

public void removeDeepChangeListener(DeepChangeListener aDCL)

Override to remove this view as change listener to children when not needed.

Overrides:

removeDeepChangeListener in class PropObject

childDidPropChange

protected void childDidPropChange(PropChange aPC)

Property change listener implementation to forward changes on to deep listeners.

childDidDeepChange

protected void childDidDeepChange(Object aLsnr,
 PropChange aPC)

Deep property change listener implementation to forward to this View's deep listeners.

themeChanged

protected void themeChanged()

Called when ViewTheme changes.

Overrides:

themeChanged in class View

initProps

protected void initProps(PropSet aPropSet)

Override to support props for this class.

Overrides:

initProps in class View

getPropValue

public Object getPropValue(String aPropName)

Override to support props for this class.

Overrides:

getPropValue in class View

setPropValue

public void setPropValue(String aPropName,
 Object aValue)

Override to support props for this class.

Overrides:

setPropValue in class View

toXML

public XMLElement toXML(XMLArchiver anArchiver)

Override to break toXML into toXMLView and toXMLChildren.

Specified by:

toXML in interface XMLArchiver.Archivable

Overrides:

toXML in class View

toXMLView

protected XMLElement toXMLView(XMLArchiver anArchiver)

XML Archival of basic view.

toXMLChildren

protected void toXMLChildren(XMLArchiver anArchiver,
 XMLElement anElement)

XML archival of children.

fromXML

public View fromXML(XMLArchiver anArchiver,
 XMLElement anElement)

Override to break fromXML into fromXMLView and fromXMLChildren.

Specified by:

fromXML in interface XMLArchiver.Archivable

Overrides:

fromXML in class View

fromXMLView

protected void fromXMLView(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival of basic view.

fromXMLChildren

protected void fromXMLChildren(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival for shape children.