Package snap.view

Class CollapseView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.CollapseView

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable, ViewHost

public class CollapseView
extends ParentView
implements ViewHost

This view subclass holds a header label and content view with support to collapse.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CollapseView.CollapseGroup	A class that tracks multiple collapsers, making sure only one is visible at a time.

Field Summary

Fields

Modifier and Type	Field	Description
static Border	LABEL_BORDER
static Color	LABEL_FILL
static Font	LABEL_FONT
static Color	LABEL_TEXT_FILL

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
CollapseView()	Constructor.
CollapseView(String aTitle, View aView)	Constructor for given View.

Method Summary

Modifier and Type	Method	Description
void	addGuest(View aChild, int anIndex)	ViewHost method: Override to set content.
protected Label	createLabel()	Creates a label.
View	getCollapseGraphic()	Returns an image of a down arrow.
CollapseView.CollapseGroup	getCollapseGroupForName(String aName)	Sets a collapse group by name.
View	getContent()	Returns the content view.
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.
Label	getLabel()	Returns the label.
protected double	getPrefHeightImpl(double aW)	Returns the preferred height.
protected double	getPrefWidthImpl(double aH)	Returns the preferred width.
String	getText()	Override to forward to label.
String	getTitle()	Returns the title.
boolean	isCollapsed()	Returns whether view is collapsed.
boolean	isExpanded()	Returns whether title view is expanded.
protected void	labelWasPressed(ViewEvent anEvent)	Called when Label is pressed.
protected void	layoutImpl()	Layout children.
View	removeGuest(int anIndex)	ViewHost method: Override to clear content (and complain if index beyond 0).
static CollapseView	replaceViewWithCollapseView(View aView, String aTitle)	Replaces given view with CollapseView with given title.
void	setCollapsed(boolean aValue)	Sets whether view is collapsed.
void	setContent(View aView)	Sets the content view.
void	setExpanded(boolean aValue)	Sets whether title view is expanded.
void	setExpandedAnimated(boolean aValue)	Sets the expanded animated.
void	setFirstFocus(View aView)	Sets the first focus component.
void	setGroupForName(String aName)	Sets a collapse group by name.
void	setText(String aStr)	Override to forward to label.
void	setTitle(String aValue)	Sets the title.
protected void	toggleExpandedAnimated(ViewEvent anEvent)	Called when Label receives a MousePress.

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, getChildrenManaged, getFocusNext, getFocusPrev, getPropValue, getViewList, getViewProxy, 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, toXMLView

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, 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, 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

LABEL_FONT

public static Font LABEL_FONT

LABEL_FILL

public static Color LABEL_FILL

LABEL_TEXT_FILL

public static Color LABEL_TEXT_FILL

LABEL_BORDER

public static Border LABEL_BORDER

Constructor Details

CollapseView

public CollapseView()

Constructor.

CollapseView

public CollapseView(String aTitle,
 View aView)

Constructor for given View.

Method Details

getTitle

public String getTitle()

Returns the title.

setTitle

public void setTitle(String aValue)

Sets the title.

getLabel

public Label getLabel()

Returns the label.

createLabel

protected Label createLabel()

Creates a label.

getContent

public View getContent()

Returns the content view.

setContent

public void setContent(View aView)

Sets the content view.

isCollapsed

public boolean isCollapsed()

Returns whether view is collapsed.

setCollapsed

public void setCollapsed(boolean aValue)

Sets whether view is collapsed.

isExpanded

public boolean isExpanded()

Returns whether title view is expanded.

setExpanded

public void setExpanded(boolean aValue)

Sets whether title view is expanded.

setExpandedAnimated

public void setExpandedAnimated(boolean aValue)

Sets the expanded animated.

toggleExpandedAnimated

protected void toggleExpandedAnimated(ViewEvent anEvent)

Called when Label receives a MousePress.

setFirstFocus

public void setFirstFocus(View aView)

Sets the first focus component.

setGroupForName

public void setGroupForName(String aName)

Sets a collapse group by name.

getCollapseGroupForName

public CollapseView.CollapseGroup getCollapseGroupForName(String aName)

Sets a collapse group by name.

labelWasPressed

protected void labelWasPressed(ViewEvent anEvent)

Called when Label is pressed.

getCollapseGraphic

public View getCollapseGraphic()

Returns an image of a down arrow.

getPrefWidthImpl

protected double getPrefWidthImpl(double aH)

Returns the preferred width.

Overrides:

getPrefWidthImpl in class View

getPrefHeightImpl

protected double getPrefHeightImpl(double aW)

Returns the preferred height.

Overrides:

getPrefHeightImpl in class View

layoutImpl

protected void layoutImpl()

Layout children.

Overrides:

layoutImpl 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

getText

public String getText()

Override to forward to label.

Overrides:

getText in class View

setText

public void setText(String aStr)

Override to forward to label.

Overrides:

setText in class View

replaceViewWithCollapseView

public static CollapseView replaceViewWithCollapseView(View aView,
 String aTitle)

Replaces given view with CollapseView with given title.