Package snap.view

Class TitleView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.TitleView

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable, ViewHost

public class TitleView
extends ParentView
implements ViewHost

A view to attach a title to another view.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TitleView.TitleArea	A View to draw content of TitleView.
static enum	TitleView.TitleStyle

Field Summary

Fields

Modifier and Type	Field	Description
static final String	Collapsible_Prop
static final String	Expanded_Prop
static final String	TitleStyle_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
TitleView()	Creates a new TitleView.
TitleView(String aTitle)	Creates a new TitleView for given title.
TitleView(String aTitle, View aView)	Creates a new TitleView for given title.

Method Summary

Modifier and Type	Method	Description
void	addGuest(View aChild, int anIndex)	ViewHost method: Override to set content.
protected TitleView.TitleArea	createArea()	Creates the Area.
protected void	fromXMLView(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
protected TitleView.TitleArea	getArea()	Returns the TitleArea.
View	getCollapseGraphic()	Returns an image of a down arrow.
View	getContent()	Returns the 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.
Label	getLabel()	Returns the label.
protected double	getPrefHeightImpl(double aW)	Override to return preferred height of content.
protected double	getPrefWidthImpl(double aH)	Override to return preferred width of content.
Object	getPropValue(String aPropName)	Override to handle additional properties.
String	getText()	Override to get from label.
TitleView.TitleStyle	getTitleStyle()	Returns the title style.
protected String	getValuePropName()	Returns a mapped property name name.
boolean	isCollapsible()	Returns whether title view is collapsible.
boolean	isContentShowing()	Returns whether content is showing.
boolean	isExpanded()	Returns whether title view is expanded.
protected void	layoutImpl()	Override to layout content.
View	removeGuest(int anIndex)	ViewHost method: Override to clear content (and complain if index beyond 0).
protected void	setArea(TitleView.TitleArea aTA)	Sets the TitleArea.
void	setCollapsible(boolean aValue)	Sets whether title view is collapsible.
void	setContent(View aView)	Sets the content.
void	setExpanded(boolean aValue)	Sets whether title view is expanded.
void	setExpandedAnimated(boolean aValue)	Sets the expanded animated.
void	setPadding(Insets theIns)	Override to forward to area.
void	setPropValue(String aPropName, Object aValue)	Override to handle additional properties.
void	setText(String aTitle)	Override to set to label.
void	setTitleStyle(TitleView.TitleStyle aTS)	Sets the title style.
protected void	toggleExpandedAnimated(ViewEvent anEvent)	Called when Label receives a MousePress.
protected 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, 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, 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, getToolTip, getToolTip, getTransX, getTransY, getUpdater, 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, 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

Collapsible_Prop

public static final String Collapsible_Prop

See Also:

• Constant Field Values

Expanded_Prop

public static final String Expanded_Prop

See Also:

• Constant Field Values

TitleStyle_Prop

public static final String TitleStyle_Prop

See Also:

• Constant Field Values

Constructor Details

TitleView

public TitleView()

Creates a new TitleView.

TitleView

public TitleView(String aTitle)

Creates a new TitleView for given title.

TitleView

public TitleView(String aTitle,
 View aView)

Creates a new TitleView for given title.

Method Details

getLabel

public Label getLabel()

Returns the label.

getText

public String getText()

Override to get from label.

Overrides:

getText in class View

setText

public void setText(String aTitle)

Override to set to label.

Overrides:

setText in class View

getContent

public View getContent()

Returns the content.

setContent

public void setContent(View aView)

Sets the content.

getTitleStyle

public TitleView.TitleStyle getTitleStyle()

Returns the title style.

setTitleStyle

public void setTitleStyle(TitleView.TitleStyle aTS)

Sets the title style.

getArea

protected TitleView.TitleArea getArea()

Returns the TitleArea.

setArea

protected void setArea(TitleView.TitleArea aTA)

Sets the TitleArea.

createArea

protected TitleView.TitleArea createArea()

Creates the Area.

isCollapsible

public boolean isCollapsible()

Returns whether title view is collapsible.

setCollapsible

public void setCollapsible(boolean aValue)

Sets whether title view is collapsible.

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.

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

isContentShowing

public boolean isContentShowing()

Returns whether content is showing.

getPrefWidthImpl

protected double getPrefWidthImpl(double aH)

Override to return preferred width of content.

Overrides:

getPrefWidthImpl in class View

getPrefHeightImpl

protected double getPrefHeightImpl(double aW)

Override to return preferred height of content.

Overrides:

getPrefHeightImpl in class View

layoutImpl

protected void layoutImpl()

Override to layout content.

Overrides:

layoutImpl in class ParentView

getCollapseGraphic

public View getCollapseGraphic()

Returns an image of a down arrow.

setPadding

public void setPadding(Insets theIns)

Override to forward to area.

Overrides:

setPadding in class View

getPropValue

public Object getPropValue(String aPropName)

Override to handle additional properties.

Overrides:

getPropValue in class ParentView

setPropValue

public void setPropValue(String aPropName,
 Object aValue)

Override to handle additional properties.

Overrides:

setPropValue in class ParentView

getValuePropName

protected String getValuePropName()

Returns a mapped property name name.

Overrides:

getValuePropName in class View

toXMLView

protected XMLElement toXMLView(XMLArchiver anArchiver)

XML archival.

Overrides:

toXMLView in class ParentView

fromXMLView

protected void fromXMLView(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival.

Overrides:

fromXMLView in class ParentView