Package snap.view

Class Label

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.Label

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

Direct Known Subclasses:

ListCell

public class Label
extends ParentView

A class to display simple text with associcated image(s).

Nested Class Summary

Nested classes/interfaces inherited from class snap.view.View

View.Overflow

Field Summary

Fields

Modifier and Type	Field	Description
protected View	_graphic
protected StringView	_stringView
static final String	Editing_Prop
static final String	Graphic_Prop
static final String	GraphicAfter_Prop
static final String	ImageName_Prop

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

Constructor	Description
Label()	Creates a label node.
Label(String aStr)	Creates a label node with given text.
Label(View aGrph, String aStr, View aGrphAfter)	Creates a label node with given graphic, text, and after graphic.

Method Summary

Modifier and Type	Method	Description
protected void	fromXMLView(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
View	getGraphic()	Returns the graphic node.
View	getGraphicAfter()	Returns the graphic node after the text.
Image	getImage()	Returns the image.
Image	getImageAfter()	Returns the image after text.
String	getImageName()	Returns the image name, if loaded from local resource.
protected double	getPrefHeightImpl(double aW)	Returns the preferred height.
protected double	getPrefWidthImpl(double aH)	Returns the preferred width.
Object	getPropValue(String aPropName)	Returns the value for given prop name.
protected StringView	getStringView()	Returns the StringView.
String	getText()	Returns the text.
Rect	getTextBounds()	Returns the text bounds.
Color	getTextColor()	Returns the text color.
TextStyle	getTextStyle()	Returns the text style.
String	getValuePropName()	Returns a mapped property name.
protected void	initProps(PropSet aPropSet)	Initialize Props.
protected boolean	isStringViewSet()	Returns the StringView.
protected void	layoutImpl()	Layout children.
void	setAlign(Pos aPos)	Override to forward to StringView.
void	setGraphic(View aGraphic)	Sets the graphic node.
void	setGraphicAfter(View aGraphic)	Sets the graphic node after the text.
void	setImage(Image anImage)	Sets the image.
void	setImageAfter(Image anImage)	Sets the image after text.
void	setImageName(String aName)	Sets the image name, if loaded from local resource.
void	setPropValue(String aPropName, Object aValue)	Sets the value for given prop name.
void	setText(String aValue)	Sets the text.
void	setTextColor(Color aColor)	Sets the text color.
void	setTextStyle(TextStyle textStyle)	Sets the text style.
void	setTextStyleString(String styleString)	Sets the text style to style updated for style string.
String	toString()	Standard toString implementation.
XMLElement	toXMLView(XMLArchiver anArchiver)	XML archival.

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

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, getMinHeightImpl, getMinSize, getMinWidth, getMinWidthImpl, 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, getToolTip, getToolTip, getTransX, getTransY, getUpdater, 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, setAlignX, setAlignY, setAnimString, setAnimTimeDeep, setBorder, setBorder, setBorderRadius, 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, 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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_stringView

protected StringView _stringView

_graphic

protected View _graphic

ImageName_Prop

public static final String ImageName_Prop

See Also:

• Constant Field Values

Graphic_Prop

public static final String Graphic_Prop

See Also:

• Constant Field Values

GraphicAfter_Prop

public static final String GraphicAfter_Prop

See Also:

• Constant Field Values

Editing_Prop

public static final String Editing_Prop

See Also:

• Constant Field Values

Constructor Details

Label

public Label()

Creates a label node.

Label

public Label(String aStr)

Creates a label node with given text.

Label

public Label(View aGrph,
 String aStr,
 View aGrphAfter)

Creates a label node with given graphic, text, and after graphic.

Method Details

getText

public String getText()

Returns the text.

Overrides:

getText in class View

setText

public void setText(String aValue)

Sets the text.

Overrides:

setText in class View

getImage

public Image getImage()

Returns the image.

setImage

public void setImage(Image anImage)

Sets the image.

getImageAfter

public Image getImageAfter()

Returns the image after text.

setImageAfter

public void setImageAfter(Image anImage)

Sets the image after text.

getTextColor

public Color getTextColor()

Returns the text color.

Overrides:

getTextColor in class View

setTextColor

public void setTextColor(Color aColor)

Sets the text color.

Overrides:

setTextColor in class View

getTextStyle

public TextStyle getTextStyle()

Returns the text style.

setTextStyle

public void setTextStyle(TextStyle textStyle)

Sets the text style.

setTextStyleString

public void setTextStyleString(String styleString)

Sets the text style to style updated for style string.

isStringViewSet

protected boolean isStringViewSet()

Returns the StringView.

getStringView

protected StringView getStringView()

Returns the StringView.

getGraphic

public View getGraphic()

Returns the graphic node.

setGraphic

public void setGraphic(View aGraphic)

Sets the graphic node.

getGraphicAfter

public View getGraphicAfter()

Returns the graphic node after the text.

setGraphicAfter

public void setGraphicAfter(View aGraphic)

Sets the graphic node after the text.

getImageName

public String getImageName()

Returns the image name, if loaded from local resource.

setImageName

public void setImageName(String aName)

Sets the image name, if loaded from local resource.

getTextBounds

public Rect getTextBounds()

Returns the text bounds.

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

getValuePropName

public String getValuePropName()

Returns a mapped property name.

Overrides:

getValuePropName in class View

setAlign

public void setAlign(Pos aPos)

Override to forward to StringView.

Overrides:

setAlign in class View

initProps

protected void initProps(PropSet aPropSet)

Initialize Props. Override to provide custom defaults.

Overrides:

initProps in class ParentView

getPropValue

public Object getPropValue(String aPropName)

Returns the value for given prop name.

Overrides:

getPropValue in class ParentView

setPropValue

public void setPropValue(String aPropName,
 Object aValue)

Sets the value for given prop name.

Overrides:

setPropValue in class ParentView

toXMLView

public 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

toString

public String toString()

Standard toString implementation.

Overrides:

toString in class PropObject