TextSel (ignition 7.9.5 API)

java.lang.Object
- com.inductiveautomation.snap.text.TextSel

public class TextSel
extends java.lang.Object

A class to represent a selection of text.

Constructor Summary

Constructors
Constructor and Description
`TextSel(Text aText, double x1, double y1, double x2, double y2, boolean isWordSel, boolean isParaSel)` Returns the selected range that would result from the given two points.
`TextSel(Text aText, int aStart, int anEnd)` Creates a new selection.
`TextSel(Text aText, int aStart, int anEnd, int anAnchor)` Creates a new selection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAnchor()` Returns the anchor.
`int`	`getCharDown()` Moves the selection index down a line, trying preserve distance from beginning of line.
`int`	`getCharLeft()` Moves the selection index backward a character (or if a range is selected, moves to beginning of range).
`int`	`getCharRight()` Moves the selection index forward a character (or if a range is selected, moves to end of range).
`int`	`getCharUp()` Moves the selection index up a line, trying to preserve distance from beginning of line.
`int`	`getEnd()` Returns the end.
`TextLine`	`getEndLine()` Returns the line at selection end.
`int`	`getLineEnd()` Moves the insertion point to next newline or text end.
`int`	`getLineStart()` Moves the insertion point to the beginning of line.
`java.awt.geom.GeneralPath`	`getPath(double aWidth)` Returns a path for two char indexes - it will be a a simple box with extensions for first/last lines.
`int`	`getSize()` The length.
`int`	`getStart()` Returns the start.
`TextLine`	`getStartLine()` Returns the line at selection start.
`java.lang.String`	`getString()` Returns the selected text string.
`Text`	`getText()` Returns the text.
`boolean`	`isEmpty()` Returns whether selection is empty.
`protected boolean`	`isWordChar(char c)` Returns whether a character should be considered is part of a word when WordSelecting.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TextSel
```
public TextSel(Text aText,
               int aStart,
               int anEnd)
```
    Creates a new selection.
  - TextSel
```
public TextSel(Text aText,
               int aStart,
               int anEnd,
               int anAnchor)
```
    Creates a new selection.
  - TextSel
```
public TextSel(Text aText,
               double x1,
               double y1,
               double x2,
               double y2,
               boolean isWordSel,
               boolean isParaSel)
```
    Returns the selected range that would result from the given two points.
- Method Detail
  - getText
```
public Text getText()
```
    Returns the text.
  - getStart
```
public int getStart()
```
    Returns the start.
  - getEnd
```
public int getEnd()
```
    Returns the end.
  - getAnchor
```
public int getAnchor()
```
    Returns the anchor.
  - getSize
```
public int getSize()
```
    The length.
  - isEmpty
```
public boolean isEmpty()
```
    Returns whether selection is empty.
  - getString
```
public java.lang.String getString()
```
    Returns the selected text string.
  - getCharRight
```
public int getCharRight()
```
    Moves the selection index forward a character (or if a range is selected, moves to end of range).
  - getCharLeft
```
public int getCharLeft()
```
    Moves the selection index backward a character (or if a range is selected, moves to beginning of range).
  - getCharUp
```
public int getCharUp()
```
    Moves the selection index up a line, trying to preserve distance from beginning of line.
  - getCharDown
```
public int getCharDown()
```
    Moves the selection index down a line, trying preserve distance from beginning of line.
  - getLineStart
```
public int getLineStart()
```
    Moves the insertion point to the beginning of line.
  - getLineEnd
```
public int getLineEnd()
```
    Moves the insertion point to next newline or text end.
  - getStartLine
```
public TextLine getStartLine()
```
    Returns the line at selection start.
  - getEndLine
```
public TextLine getEndLine()
```
    Returns the line at selection end.
  - getPath
```
public java.awt.geom.GeneralPath getPath(double aWidth)
```
    Returns a path for two char indexes - it will be a a simple box with extensions for first/last lines.
  - isWordChar
```
protected boolean isWordChar(char c)
```
    Returns whether a character should be considered is part of a word when WordSelecting.

Class TextSel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TextSel

TextSel

TextSel

Method Detail

getText

getStart

getEnd

getAnchor

getSize

isEmpty

getString

getCharRight

getCharLeft

getCharUp

getCharDown

getLineStart

getLineEnd

getStartLine

getEndLine

getPath

isWordChar