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).

Field Summary

Fields

Modifier and Type	Field	Description
protected View	_graphic
protected StringView	_stringView
static final String	Editable_Prop
static final String	Editing_Prop
static final String	Graphic_Prop
static final String	GraphicAfter_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, 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
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	editorFiredAction()	Called when editor fires action.
protected void	editorFocusChanged(TextField editor)	Called when editor focus changes.
protected void	fromXMLView(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
TextField	getEditor()	Returns the editor.
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.
StringView	getStringView()	Returns the StringView.
String	getText()	Returns the text.
Paint	getTextFill()	Returns the text fill.
TextStyle	getTextStyle()	Returns the text style.
String	getValuePropName()	Returns a mapped property name.
boolean	isEditable()	Returns whether label text is editable.
boolean	isEditing()	Returns whether editable.
boolean	isStringViewSet()	Returns the StringView.
protected void	layoutImpl()	Layout children.
protected void	processEvent(ViewEvent anEvent)	Handle events.
void	setAlign(Pos aPos)	Override to forward to StringView.
void	setEditable(boolean aValue)	Sets whether label text is editable.
void	setEditing(boolean aValue)	Sets editing.
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	setText(String aValue)	Sets the text.
void	setTextFill(Paint aPaint)	Sets the text fill.
void	setTextStyle(TextStyle textStyle)	Sets the text style.
void	setTextStylePropsString(String propsString)	Sets the text style to style updated for props 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, getChildAt, getChildAt, getChildCount, getChildCountManaged, getChildForClass, getChildForName, getChildLast, getChildren, getChildrenForClass, getChildrenInPaintOrder, getChildrenManaged, getFocusNext, getFocusPrev, getPropValue, getViewList, getViewProxy, indexOfChild, initProps, intersectsShape, 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, 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, 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, processEventAll, processEventFilters, processEventHandlers, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, runDelayed, runIntervals, runLater, scrollToVisible, setActionable, 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, 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

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

Editable_Prop

public static final String Editable_Prop

See Also:

• Constant Field Values

Editing_Prop

public static final String Editing_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

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.

getTextFill

public Paint getTextFill()

Returns the text fill.

setTextFill

public void setTextFill(Paint aPaint)

Sets the text fill.

getTextStyle

public TextStyle getTextStyle()

Returns the text style.

setTextStyle

public void setTextStyle(TextStyle textStyle)

Sets the text style.

setTextStylePropsString

public void setTextStylePropsString(String propsString)

Sets the text style to style updated for props string.

isStringViewSet

public boolean isStringViewSet()

Returns the StringView.

getStringView

public 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.

isEditable

public boolean isEditable()

Returns whether label text is editable.

setEditable

public void setEditable(boolean aValue)

Sets whether label text is editable.

isEditing

public boolean isEditing()

Returns whether editable.

setEditing

public void setEditing(boolean aValue)

Sets editing.

getEditor

public TextField getEditor()

Returns the editor.

editorFiredAction

protected void editorFiredAction()

Called when editor fires action.

editorFocusChanged

protected void editorFocusChanged(TextField editor)

Called when editor focus changes.

processEvent

protected void processEvent(ViewEvent anEvent)

Handle events.

Overrides:

processEvent in class View

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

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