Document (Jexer - Java Text User Interface

java.lang.Object
- jexer.teditor.Document

```
public class Document
extends java.lang.Object
```
A Document represents a text file, as a collection of lines.

Constructor Summary

Constructors
Constructor and Description

Document(java.lang.String str, CellAttributes defaultColor)
Construct a new Document from an existing text string.

Constructors
Constructor and Description
`Document(java.lang.String str, CellAttributes defaultColor)` Construct a new Document from an existing text string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChar(int ch)` Replace or insert a character at the cursor, depending on overwrite flag.
`void`	`backspace()` Delete the character immediately preceeding the cursor.
`void`	`backwardsWord()` Go back to the beginning of this word if in the middle, or the beginning of the previous word.
`void`	`del()` Delete the character under the cursor.
`boolean`	`down()` Increment the line number by one.
`boolean`	`down(int n)` Increment the line number by n.
`boolean`	`end()` Go to the last column of this line.
`void`	`enter()` Split the current line into two, like pressing the enter key.
`void`	`forwardsWord()` Go to the beginning of the next word.
`int`	`getChar()` Get the character at the current cursor position in the text.
`Line`	`getCurrentLine()` Get the current editing line.
`int`	`getCursor()` Get the current cursor position of the editing line.
`Line`	`getLine(int lineNumber)` Get a specific line by number.
`int`	`getLineCount()` Get the number of lines.
`int`	`getLineLength()` Get the current line length.
`int`	`getLineLengthMax()` Compute the maximum line length for this document.
`int`	`getLineNumber()` Get the current line number being edited.
`java.util.List<Line>`	`getLines()` Get a (shallow) copy of the list of lines.
`boolean`	`getOverwrite()` Get the overwrite flag.
`java.lang.String`	`getRawLine()` Get the raw string that matches this line.
`boolean`	`home()` Go to the first column of this line.
`boolean`	`isDirty()` Get the dirty value.
`boolean`	`left()` Decrement the cursor by one.
`boolean`	`right()` Increment the cursor by one.
`void`	`saveToFilename(java.lang.String filename)` Save contents to file.
`void`	`setCursor(int cursor)` Set the current cursor position of the editing line.
`void`	`setLineNumber(int n)` Set the current line number being edited.
`void`	`setOverwrite(boolean overwrite)` Set the overwrite flag.
`boolean`	`up()` Decrement the line number by one.
`boolean`	`up(int n)` Decrement the line number by n.

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

- Constructor Detail
  - Document
```
public Document(java.lang.String str,
                CellAttributes defaultColor)
```
    Construct a new Document from an existing text string.
    
    Parameters:
    
    str - the text string
    
    defaultColor - the color for unhighlighted text
- Method Detail
  - getOverwrite
```
public boolean getOverwrite()
```
    Get the overwrite flag.
    
    Returns:
    
    true if addChar() overwrites data, false if it inserts
  - isDirty
```
public boolean isDirty()
```
    Get the dirty value.
    
    Returns:
    
    true if the buffer is dirty
  - saveToFilename
```
public void saveToFilename(java.lang.String filename)
                    throws java.io.IOException
```
    Save contents to file.
    
    Parameters:
    
    filename - file to save to
    
    Throws:
    
    java.io.IOException - if a java.io operation throws
  - setOverwrite
```
public void setOverwrite(boolean overwrite)
```
    Set the overwrite flag.
    
    Parameters:
    
    overwrite - true if addChar() should overwrite data, false if it should insert
  - getLineNumber
```
public int getLineNumber()
```
    Get the current line number being edited.
    
    Returns:
    
    the line number. Note that this is 0-based: 0 is the first line.
  - getCurrentLine
```
public Line getCurrentLine()
```
    Get the current editing line.
    
    Returns:
    
    the line
  - getLine
```
public Line getLine(int lineNumber)
```
    Get a specific line by number.
    
    Parameters:
    
    lineNumber - the line number. Note that this is 0-based: 0 is the first line.
    
    Returns:
    
    the line
  - setLineNumber
```
public void setLineNumber(int n)
```
    Set the current line number being edited.
    
    Parameters:
    
    n - the line number. Note that this is 0-based: 0 is the first line.
  - getCursor
```
public int getCursor()
```
    Get the current cursor position of the editing line.
    
    Returns:
    
    the cursor position
  - getChar
```
public int getChar()
```
    Get the character at the current cursor position in the text.
    
    Returns:
    
    the character, or -1 if the cursor is at the end of the line
  - setCursor
```
public void setCursor(int cursor)
```
    Set the current cursor position of the editing line. 0-based.
    
    Parameters:
    
    cursor - the new cursor position
  - down
```
public boolean down()
```
    Increment the line number by one. If at the last line, do nothing.
    
    Returns:
    
    true if the editing line changed
  - down
```
public boolean down(int n)
```
    Increment the line number by n. If n would go past the last line, increment only to the last line.
    
    Parameters:
    
    n - the number of lines to increment by
    
    Returns:
    
    true if the editing line changed
  - up
```
public boolean up()
```
    Decrement the line number by one. If at the first line, do nothing.
    
    Returns:
    
    true if the editing line changed
  - up
```
public boolean up(int n)
```
    Decrement the line number by n. If n would go past the first line, decrement only to the first line.
    
    Parameters:
    
    n - the number of lines to decrement by
    
    Returns:
    
    true if the editing line changed
  - left
```
public boolean left()
```
    Decrement the cursor by one. If at the first column on the first line, do nothing.
    
    Returns:
    
    true if the cursor position changed
  - right
```
public boolean right()
```
    Increment the cursor by one. If at the last column on the last line, do nothing.
    
    Returns:
    
    true if the cursor position changed
  - backwardsWord
```
public void backwardsWord()
```
    Go back to the beginning of this word if in the middle, or the beginning of the previous word.
  - forwardsWord
```
public void forwardsWord()
```
    Go to the beginning of the next word.
  - getRawLine
```
public java.lang.String getRawLine()
```
    Get the raw string that matches this line.
    
    Returns:
    
    the string
  - home
```
public boolean home()
```
    Go to the first column of this line.
    
    Returns:
    
    true if the cursor position changed
  - end
```
public boolean end()
```
    Go to the last column of this line.
    
    Returns:
    
    true if the cursor position changed
  - del
```
public void del()
```
    Delete the character under the cursor.
  - backspace
```
public void backspace()
```
    Delete the character immediately preceeding the cursor.
  - enter
```
public void enter()
```
    Split the current line into two, like pressing the enter key.
  - addChar
```
public void addChar(int ch)
```
    Replace or insert a character at the cursor, depending on overwrite flag.
    
    Parameters:
    
    ch - the character to replace or insert
  - getLines
```
public java.util.List<Line> getLines()
```
    Get a (shallow) copy of the list of lines.
    
    Returns:
    
    the list of lines
  - getLineCount
```
public int getLineCount()
```
    Get the number of lines.
    
    Returns:
    
    the number of lines
  - getLineLengthMax
```
public int getLineLengthMax()
```
    Compute the maximum line length for this document.
    
    Returns:
    
    the number of cells needed to display the longest line
  - getLineLength
```
public int getLineLength()
```
    Get the current line length.
    
    Returns:
    
    the number of cells needed to display the current line

Class Document

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Document

Method Detail

getOverwrite

isDirty

saveToFilename

setOverwrite

getLineNumber

getCurrentLine

getLine

setLineNumber

getCursor

getChar

setCursor

down

down

up

up

left

right

backwardsWord

forwardsWord

getRawLine

home

end

del

backspace

enter

addChar

getLines

getLineCount

getLineLengthMax

getLineLength