Package snap.view

Class StringView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.StringView

All Implemented Interfaces:

Cloneable, PropChange.DoChange, XMLArchiver.Archivable

public class StringView
extends View
implements Cloneable

A view subclass to display a text string in a single style.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FontSizing_Prop
static final String	ShrinkToFit_Prop
static final String	TextStyle_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
StringView()	Constructor.
StringView(String aString)	Constructor with string.

Method Summary

Modifier and Type	Method	Description
StringView	clone()	Returns a copy of this StringView.
View	fromXML(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
double	getAscent()	Returns the ascent.
int	getCharIndexForX(double aX)	Returns the char index for the X location.
double	getDescent()	Returns the descent.
protected double	getPrefHeightImpl(double aW)	Returns the preferred height.
protected double	getPrefWidthImpl(double aH)	Returns the preferred width.
TextStyle	getStyle()	Returns the TextStyle.
String	getText()	Returns the text.
Rect	getTextBounds()	Returns the text bounds.
Rect	getTextBounds(int aStart, int aEnd)	Returns the text bounds for the given range of characters.
Paint	getTextFill()	Returns the text fill.
double	getTextHeight()	Returns the height of the current string/font (aka the 'line height').
double	getTextWidth()	Returns the width of the string (aka the 'advance').
boolean	isFontSizing()	Returns whether to size to font (looser) instead of glyphs (tighter).
boolean	isShrinkToFit()	Returns whether text should shrink to fit.
boolean	isTextFits()	Returns whether text fits in box.
int	length()	Returns the text length.
protected void	paintFront(Painter aPntr)	Paints StringView.
protected void	paintString(Painter aPntr)	Paints StringView.
void	paintStringView(Painter aPntr)	A paint method for painting StringView outside of View hierarchy.
protected void	parentFontChanged()	Override to update TextRun.
void	relayout()	Override to clear size info.
void	relayoutParent()	Override to clear size info.
void	setCenteredXY(double aX, double aY)	Sets the box centered around given X/Y.
void	setFont(Font aFont)	Override to update TextRun.
void	setFontSizing(boolean aValue)	Sets whether to size to font (looser) instead of glyphs (tighter).
void	setHeight(double aValue)	Override to clear NeedsResize.
void	setShrinkToFit(boolean aValue)	Sets whether text should shrink to fit.
void	setStyle(TextStyle aStyle)	Sets the TextStyle.
void	setText(String aValue)	Sets the text.
void	setTextFill(Paint aPaint)	Sets the text fill.
void	setWidth(double aValue)	Override to clear NeedsResize.
XMLElement	toXML(XMLArchiver anArchiver)	XML archival.

Methods inherited from class snap.view.View

addBinding, addEventFilter, addEventHandler, 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, getPropValue, getRealClassName, getRepaintRect, getRepaintRectExpanded, getRootView, getRotate, getScale, getScaleX, getScaleY, getSize, getSpacing, getToolTip, getToolTip, getTransX, getTransY, getUpdater, getValuePropName, getVisRect, getWidth, getWindow, getX, getXY, getY, indexInHost, indexInParent, initProps, intersects, 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, paintAll, paintBack, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEvent, processEventFilters, processEventHandlers, 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, setLean, setLeanX, setLeanY, setManaged, setMargin, setMargin, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth, setName, setOpacity, setOwner, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setPropValue, setRealClassName, setRotate, setScale, setScaleX, setScaleY, setShowing, setSize, setSize, setSizeLocal, setSizeToPrefSize, setSpacing, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setVisible, setX, setXY, setXYLocal, setY, stopAnimDeep, themeChanged, toStringProps

Methods inherited from class snap.props.PropObject

addDeepChangeListener, addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, isPropDefault, processPropChange, removeDeepChangeListener, removePropChangeListener, removePropChangeListener, toString

Methods inherited from class java.lang.Object

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

Field Details

TextStyle_Prop

public static final String TextStyle_Prop

See Also:

• Constant Field Values

FontSizing_Prop

public static final String FontSizing_Prop

See Also:

• Constant Field Values

ShrinkToFit_Prop

public static final String ShrinkToFit_Prop

See Also:

• Constant Field Values

Constructor Details

StringView

public StringView()

Constructor.

StringView

public StringView(String aString)

Constructor with string.

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

getStyle

public TextStyle getStyle()

Returns the TextStyle.

setStyle

public void setStyle(TextStyle aStyle)

Sets the TextStyle.

getTextFill

public Paint getTextFill()

Returns the text fill.

setTextFill

public void setTextFill(Paint aPaint)

Sets the text fill.

isFontSizing

public boolean isFontSizing()

Returns whether to size to font (looser) instead of glyphs (tighter).

setFontSizing

public void setFontSizing(boolean aValue)

Sets whether to size to font (looser) instead of glyphs (tighter).

isShrinkToFit

public boolean isShrinkToFit()

Returns whether text should shrink to fit.

setShrinkToFit

public void setShrinkToFit(boolean aValue)

Sets whether text should shrink to fit.

length

public int length()

Returns the text length.

getTextWidth

public double getTextWidth()

Returns the width of the string (aka the 'advance').

getTextHeight

public double getTextHeight()

Returns the height of the current string/font (aka the 'line height').

getAscent

public double getAscent()

Returns the ascent.

getDescent

public double getDescent()

Returns the descent.

isTextFits

public boolean isTextFits()

Returns whether text fits in box.

getTextBounds

public Rect getTextBounds()

Returns the text bounds.

getTextBounds

public Rect getTextBounds(int aStart,
 int aEnd)

Returns the text bounds for the given range of characters.

getCharIndexForX

public int getCharIndexForX(double aX)

Returns the char index for the X location.

setCenteredXY

public void setCenteredXY(double aX,
 double aY)

Sets the box centered around given X/Y.

relayout

public void relayout()

Override to clear size info.

Overrides:

relayout in class View

relayoutParent

public void relayoutParent()

Override to clear size info.

Overrides:

relayoutParent 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

paintStringView

public void paintStringView(Painter aPntr)

A paint method for painting StringView outside of View hierarchy.

paintFront

protected void paintFront(Painter aPntr)

Paints StringView.

Overrides:

paintFront in class View

paintString

protected void paintString(Painter aPntr)

Paints StringView.

setFont

public void setFont(Font aFont)

Override to update TextRun.

Overrides:

setFont in class View

parentFontChanged

protected void parentFontChanged()

Override to update TextRun.

Overrides:

parentFontChanged in class View

setWidth

public void setWidth(double aValue)

Override to clear NeedsResize.

Overrides:

setWidth in class View

setHeight

public void setHeight(double aValue)

Override to clear NeedsResize.

Overrides:

setHeight in class View

clone

public StringView clone()

Returns a copy of this StringView.

Overrides:

clone in class View

toXML

public XMLElement toXML(XMLArchiver anArchiver)

XML archival.

Specified by:

toXML in interface XMLArchiver.Archivable

Overrides:

toXML in class View

fromXML

public View fromXML(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival.

Specified by:

fromXML in interface XMLArchiver.Archivable

Overrides:

fromXML in class View