Package snap.view

Class TextView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.TextView

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

public class TextView
extends ParentView

This view subclass wraps a TextArea in a ScrollView.

Field Summary

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
TextView()	Constructor.
TextView(boolean isRichText)	Constructor with option for RichText.

Method Summary

Modifier and Type	Method	Description
char	charAt(int anIndex)	Returns the individual character at given index.
void	fromXMLView(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
protected double	getPrefHeightImpl(double aW)	Returns the height needed to display all characters.
protected double	getPrefWidthImpl(double aH)	Returns the width needed to display all characters.
ScrollView	getScrollView()	Returns the ScrollView.
TextSel	getSel()	Returns the text selection.
int	getSelEnd()	Returns the character index of the end of the text selection.
int	getSelIndex()	Returns the final character index of the selection (usually SelEnd).
int	getSelStart()	Returns the character index of the start of the text selection.
String	getText()	Returns the plain string of the text being edited.
TextArea	getTextArea()	Returns the TextArea.
TextBlock	getTextBlock()	Returns the text that is being edited.
String	getValuePropName()	Returns a mapped property name.
boolean	isSelEmpty()	Returns whether the selection is empty.
protected void	layoutImpl()	Actual method to layout children.
int	length()	Returns the number of characters in the text string.
void	selectAll()	Selects all the characters in the text editor.
void	setBorderRadius(double aValue)	Override to sync ScrollView and TextArea.
void	setFireActionOnFocusLost(boolean aValue)	Sets whether text area sends action on focus lost (if text changed).
void	setSel(int newStartEnd)	Sets the character index of the text cursor.
void	setSel(int aStart, int aEnd)	Sets the character index of the start and end of the text selection.
void	setText(String aString)	Set text string of text editor.
void	setWrapLines(boolean aValue)	Sets whether to wrap lines that overrun bounds.
protected void	textAreaDidPropChange(PropChange aPC)	Called when TextArea gets prop changes.
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, processEvent, processEventAll, processEventFilters, processEventHandlers, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, runDelayed, runIntervals, runLater, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, setAnimProps, setAnimString, setAnimTimeDeep, setBorder, setBorder, 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, toString

Methods inherited from class java.lang.Object

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

Constructor Details

TextView

public TextView()

Constructor.

TextView

public TextView(boolean isRichText)

Constructor with option for RichText.

Method Details

getTextArea

public TextArea getTextArea()

Returns the TextArea.

getScrollView

public ScrollView getScrollView()

Returns the ScrollView.

getTextBlock

public TextBlock getTextBlock()

Returns the text that is being edited.

getText

public String getText()

Returns the plain string of the text being edited.

Overrides:

getText in class View

setText

public void setText(String aString)

Set text string of text editor.

Overrides:

setText in class View

setWrapLines

public void setWrapLines(boolean aValue)

Sets whether to wrap lines that overrun bounds.

setFireActionOnFocusLost

public void setFireActionOnFocusLost(boolean aValue)

Sets whether text area sends action on focus lost (if text changed).

length

public int length()

Returns the number of characters in the text string.

charAt

public char charAt(int anIndex)

Returns the individual character at given index.

isSelEmpty

public boolean isSelEmpty()

Returns whether the selection is empty.

getSelIndex

public int getSelIndex()

Returns the final character index of the selection (usually SelEnd).

getSelStart

public int getSelStart()

Returns the character index of the start of the text selection.

getSelEnd

public int getSelEnd()

Returns the character index of the end of the text selection.

getSel

public TextSel getSel()

Returns the text selection.

setSel

public void setSel(int newStartEnd)

Sets the character index of the text cursor.

setSel

public void setSel(int aStart,
 int aEnd)

Sets the character index of the start and end of the text selection.

selectAll

public void selectAll()

Selects all the characters in the text editor.

getPrefWidthImpl

protected double getPrefWidthImpl(double aH)

Returns the width needed to display all characters.

Overrides:

getPrefWidthImpl in class View

getPrefHeightImpl

protected double getPrefHeightImpl(double aW)

Returns the height needed to display all characters.

Overrides:

getPrefHeightImpl in class View

layoutImpl

protected void layoutImpl()

Actual method to layout children.

Overrides:

layoutImpl in class ParentView

getValuePropName

public String getValuePropName()

Returns a mapped property name.

Overrides:

getValuePropName in class View

setBorderRadius

public void setBorderRadius(double aValue)

Override to sync ScrollView and TextArea.

Overrides:

setBorderRadius in class View

textAreaDidPropChange

protected void textAreaDidPropChange(PropChange aPC)

Called when TextArea gets prop changes.

toXMLView

public XMLElement toXMLView(XMLArchiver anArchiver)

XML archival.

Overrides:

toXMLView in class ParentView

fromXMLView

public void fromXMLView(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival.

Overrides:

fromXMLView in class ParentView