Package snap.view

Class BoxView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.BoxView

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable, ViewHost

Direct Known Subclasses:

ScaleBox

public class BoxView
extends ParentView
implements ViewHost

A View that holds another view.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	Content_Prop
static final String	FillHeight_Prop
static final String	FillWidth_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, 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
BoxView()	Constructor.
BoxView(View aContent)	Constructor for content.
BoxView(View aContent, boolean isFillWidth, boolean isFillHeight)	Constructor for content with FillWidth, FillHeight params.

Method Summary

Modifier and Type	Method	Description
void	addGuest(View aChild, int anIndex)	ViewHost method: Override to set content.
void	fromXMLView(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
View	getContent()	Returns the box content.
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.
static double	getPrefHeight(ParentView aParent, View aChild, double aW)	Returns preferred height of layout.
protected double	getPrefHeightImpl(double aW)	Override.
static double	getPrefWidth(ParentView aParent, View aChild, double aH)	Returns preferred width of layout.
protected double	getPrefWidthImpl(double aH)	Override.
protected BoxViewProxy<?>	getViewProxy()	Override to return BoxViewProxy.
boolean	isFillHeight()	Returns whether children will be resized to fill height.
boolean	isFillWidth()	Returns whether children will be resized to fill width.
static void	layout(ParentView aPar, View aChild, boolean isFillWidth, boolean isFillHeight)	Performs Box layout for given parent, child and fill width/height.
protected void	layoutImpl()	Override.
View	removeGuest(int anIndex)	ViewHost method: Override to clear content (and complain if index beyond 0).
void	setContent(View aView)	Sets the box content.
void	setContentWithAnim(View aView)	Sets the content with animation.
void	setFillHeight(boolean aValue)	Sets whether children will be resized to fill height.
void	setFillWidth(boolean aValue)	Sets whether children will be resized to fill width.
XMLElement	toXMLView(XMLArchiver anArchiver)	XML archival.

Methods inherited from class snap.view.ParentView

addChild, addChild, addDeepChangeListener, childDidDeepChange, childDidPropChange, fromXML, fromXMLChildren, getChild, getChildAt, getChildAt, getChildCount, getChildCountManaged, getChildForClass, getChildForName, getChildLast, getChildren, getChildrenForClass, getChildrenManaged, getFocusNext, getFocusPrev, getPropValue, getViewList, indexOfChild, initProps, intersects, 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, contains, disableEvents, dispatchEventToView, 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, 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, processEventFilters, processEventHandlers, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, 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, setSizeToPrefSize, setSpacing, setText, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setVisible, setWidth, setX, setXY, setXYLocal, setY, stopAnimDeep, toStringProps

Methods inherited from class snap.props.PropObject

addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, isPropDefault, removePropChangeListener, removePropChangeListener, 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, indexOfGuest, removeGuest, removeGuests

Field Details

FillWidth_Prop

public static final String FillWidth_Prop

See Also:

• Constant Field Values

FillHeight_Prop

public static final String FillHeight_Prop

See Also:

• Constant Field Values

Content_Prop

public static final String Content_Prop

See Also:

• Constant Field Values

Constructor Details

BoxView

public BoxView()

Constructor.

BoxView

public BoxView(View aContent)

Constructor for content.

BoxView

public BoxView(View aContent,
 boolean isFillWidth,
 boolean isFillHeight)

Constructor for content with FillWidth, FillHeight params.

Method Details

getContent

public View getContent()

Returns the box content.

setContent

public void setContent(View aView)

Sets the box content.

isFillWidth

public boolean isFillWidth()

Returns whether children will be resized to fill width.

setFillWidth

public void setFillWidth(boolean aValue)

Sets whether children will be resized to fill width.

isFillHeight

public boolean isFillHeight()

Returns whether children will be resized to fill height.

setFillHeight

public void setFillHeight(boolean aValue)

Sets whether children will be resized to fill height.

getPrefWidthImpl

protected double getPrefWidthImpl(double aH)

Override.

Overrides:

getPrefWidthImpl in class View

getPrefHeightImpl

protected double getPrefHeightImpl(double aW)

Override.

Overrides:

getPrefHeightImpl in class View

layoutImpl

protected void layoutImpl()

Override.

Overrides:

layoutImpl in class ParentView

getViewProxy

protected BoxViewProxy<?> getViewProxy()

Override to return BoxViewProxy.

Overrides:

getViewProxy in class ParentView

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

setContentWithAnim

public void setContentWithAnim(View aView)

Sets the content with animation.

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

getPrefWidth

public static double getPrefWidth(ParentView aParent,
 View aChild,
 double aH)

Returns preferred width of layout.

getPrefHeight

public static double getPrefHeight(ParentView aParent,
 View aChild,
 double aW)

Returns preferred height of layout.

layout

public static void layout(ParentView aPar,
 View aChild,
 boolean isFillWidth,
 boolean isFillHeight)

Performs Box layout for given parent, child and fill width/height.