Paragraph

java.lang.Object
- org.openlowcode.tools.richtext.Paragraph

```
public class Paragraph
extends java.lang.Object
```
This class represents a paragraph inside a textflow. It may include text in different formatting. However, the following features will be their own paragraph:
- title
- each bullet point in a bullet list
Author:

Open Lowcode SAS

Constructor Summary

Constructors
Constructor and Description
`Paragraph(boolean richtext, boolean editable, RichTextArea parent)` creates an empty paragraph
`Paragraph(java.lang.String simpletext, boolean richtext, boolean editable, RichTextArea parent)` creates a paragraph with the text in input (can have formatting if rich text)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dirtyhackcaretminus()` specific hack for ASCII character 22
`void`	`displayCaretAt(int selectionintextflow)`
`protected void`	`displaySelection()`
`java.lang.String`	`dropText()` provides the encoded text description of the paragraph following Open Lowcode rich text
`Paragraph`	`generateParagraphAfterNextBreak()` returns a paragraph with all formatted text after the carret, and, if existing, any text after the first carriage return in current formatted text
`Paragraph`	`generateParagraphBeforePreviousBreak()` returns a paragraph with all formatted text before the carret, and, if existing, any text before the last carriage return in current formatted text before the caret
`Paragraph`	`generateParagraphbetweenBreak()` generates a paragraph between two carriage returns
`protected int`	`getCharAt(int charIndex)`
`int`	`getCharNb()`
`int`	`getCharSelectionOnCoordinates(double x, double y)` selects the char corresponding to points x and y
`int`	`getLastLine()`
`int`	`getLineForCarret()`
`javafx.scene.Node`	`getNode()`
`float`	`getXOffSetForSelection()`
`void`	`giveBackFocus()` gets back the focus on this item
`boolean`	`hasSelection()`
`boolean`	`hasSignificantContent()`
`protected void`	`hideSelection()`
`protected void`	`hideSelectionAndResetIndex()`
`void`	`insertBoldIndicator(boolean selected)` insert bold indicator
`void`	`insertColorIndicator(javafx.scene.paint.Color value)` inserts a color indicator at the current caret position
`void`	`insertItalicIndicator(boolean selected)` insert italic indicator
`void`	`insertTextAtFirst(java.lang.String text)` inserts text at the beginning
`boolean`	`isNormal()`
`boolean`	`isSelectionAtFirstLine()`
`boolean`	`isSelectionAtLastLine()`
`void`	`reformatTextFollowingParagraph()` reformats the text
`java.lang.String`	`returnSelectedText()`
`void`	`setBulletParagraph()` sets the paragraph to bullet point
`void`	`setNormalParagraph()` sets the paragraph to normal
`void`	`setSelectionat(int line, float caretindex)` sets the selection for the given line, with the given caret index
`void`	`setTitleParagraph()` sets the paragraph to title

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

- Constructor Detail
  - Paragraph
```
public Paragraph(java.lang.String simpletext,
                 boolean richtext,
                 boolean editable,
                 RichTextArea parent)
```
    creates a paragraph with the text in input (can have formatting if rich text)
    
    Parameters:
    
    simpletext - simple text
    
    richtext - true if rich text formatting is possible
    
    editable - true if editable
    
    parent - parent rich text area
  - Paragraph
```
public Paragraph(boolean richtext,
                 boolean editable,
                 RichTextArea parent)
```
    creates an empty paragraph
    
    Parameters:
    
    richtext - true if richtext
    
    editable - true if editable
    
    parent - the parent richtextarea
- Method Detail
  - dropText
```
public java.lang.String dropText()
```
    provides the encoded text description of the paragraph following Open Lowcode rich text
    
    Returns:
    
    the encoded string with the content of this paragraph
  - hasSelection
```
public boolean hasSelection()
```
    Returns:
    
    true if there is a valid selection of text
  - returnSelectedText
```
public java.lang.String returnSelectedText()
```
    Returns:
    
    just the selected text
  - getCharNb
```
public int getCharNb()
```
    Returns:
    
    the number of characters in that paragraph
  - setBulletParagraph
```
public void setBulletParagraph()
```
    sets the paragraph to bullet point
  - setTitleParagraph
```
public void setTitleParagraph()
```
    sets the paragraph to title
  - setNormalParagraph
```
public void setNormalParagraph()
```
    sets the paragraph to normal
  - reformatTextFollowingParagraph
```
public void reformatTextFollowingParagraph()
```
    reformats the text
  - getNode
```
public javafx.scene.Node getNode()
```
    Returns:
    
    gets the node representing this paragraph
  - displayCaretAt
```
public void displayCaretAt(int selectionintextflow)
```
    Parameters:
    
    selectionintextflow - displays the caret at the given selection in the text flow
  - isSelectionAtFirstLine
```
public boolean isSelectionAtFirstLine()
```
    Returns:
    
    true if the current selection is the first line, false else
  - isSelectionAtLastLine
```
public boolean isSelectionAtLastLine()
```
    Returns:
    
    true if the current selection is the last line, false else
  - getLastLine
```
public int getLastLine()
```
    Returns:
    
    the number of lines in the text
  - getXOffSetForSelection
```
public float getXOffSetForSelection()
```
    Returns:
    
    the xoffset for the selection. Paragraphs, depending on size, have differrent offsets (titles to the left, bullet points to the right)
  - setSelectionat
```
public void setSelectionat(int line,
                           float caretindex)
```
    sets the selection for the given line, with the given caret index
    
    Parameters:
    
    line - an integer between 0 and the index of last line
    
    caretindex - actual position of thecaret in pixels
  - getLineForCarret
```
public int getLineForCarret()
```
    Returns:
    
    get the line on which the caret is
  - getCharSelectionOnCoordinates
```
public int getCharSelectionOnCoordinates(double x,
                                         double y)
```
    selects the char corresponding to points x and y
    
    Parameters:
    
    x - x mouse click coordinate
    
    y - y mouse clock coordinate
    
    Returns:
    
    the closest character index if hit
  - hideSelection
```
protected void hideSelection()
```
  - hideSelectionAndResetIndex
```
protected void hideSelectionAndResetIndex()
```
  - displaySelection
```
protected void displaySelection()
```
  - getCharAt
```
protected int getCharAt(int charIndex)
```
  - hasSignificantContent
```
public boolean hasSignificantContent()
```
    Returns:
    
    true if there is any significant text
  - giveBackFocus
```
public void giveBackFocus()
```
    gets back the focus on this item
  - dirtyhackcaretminus
```
public void dirtyhackcaretminus()
```
    specific hack for ASCII character 22
  - insertColorIndicator
```
public void insertColorIndicator(javafx.scene.paint.Color value)
```
    inserts a color indicator at the current caret position
    
    Parameters:
    
    value - color indicator
  - insertBoldIndicator
```
public void insertBoldIndicator(boolean selected)
```
    insert bold indicator
    
    Parameters:
    
    selected - true to put bold, false, to put back to normal
  - insertItalicIndicator
```
public void insertItalicIndicator(boolean selected)
```
    insert italic indicator
    
    Parameters:
    
    selected - true to start an italic section, false to end an italic section
  - generateParagraphBeforePreviousBreak
```
public Paragraph generateParagraphBeforePreviousBreak()
```
    returns a paragraph with all formatted text before the carret, and, if existing, any text before the last carriage return in current formatted text before the caret
    
    Returns:
  - generateParagraphAfterNextBreak
```
public Paragraph generateParagraphAfterNextBreak()
```
    returns a paragraph with all formatted text after the carret, and, if existing, any text after the first carriage return in current formatted text
    
    Returns:
  - generateParagraphbetweenBreak
```
public Paragraph generateParagraphbetweenBreak()
```
    generates a paragraph between two carriage returns
    
    Returns:
    
    the paragraph to generate
  - isNormal
```
public boolean isNormal()
```
    Returns:
    
    true if paragraph is normal
  - insertTextAtFirst
```
public void insertTextAtFirst(java.lang.String text)
```
    inserts text at the beginning
    
    Parameters:
    
    text - text to insert (can be encoded rich text)

Class Paragraph

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Paragraph

Paragraph

Method Detail

dropText

hasSelection

returnSelectedText

getCharNb

setBulletParagraph

setTitleParagraph

setNormalParagraph

reformatTextFollowingParagraph

getNode

displayCaretAt

isSelectionAtFirstLine

isSelectionAtLastLine

getLastLine

getXOffSetForSelection

setSelectionat

getLineForCarret

getCharSelectionOnCoordinates

hideSelection

hideSelectionAndResetIndex

displaySelection

getCharAt

hasSignificantContent

giveBackFocus

dirtyhackcaretminus

insertColorIndicator

insertBoldIndicator

insertItalicIndicator

generateParagraphBeforePreviousBreak

generateParagraphAfterNextBreak

generateParagraphbetweenBreak

isNormal

insertTextAtFirst