com.vaadin.shared.ui.richtextarea

Class Snippet

java.lang.Object

com.vaadin.shared.ui.richtextarea.Snippet

All Implemented Interfaces:

Serializable

public class Snippet
extends Object
implements Serializable

Supporting data structure for snippets feature.

Since:

8.16

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	text
String	title

Constructor Summary

Constructors

Constructor and Description
Snippet() Creates an empty snippet
Snippet(String text) Creates a snippet with a specified body text.
Snippet(String title, String text) Creates a snippet with a specified title and text.

Method Summary

Modifier and Type	Method and Description
String	getText() Get the snippet content text.
String	getTitle() Get the set title text (either a user-specified string or up to 20 characters of the main snippet text.

Methods inherited from class java.lang.Object

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

Field Detail

title

public String title

text

public String text

Constructor Detail

Snippet

public Snippet()

Creates an empty snippet

Snippet

public Snippet(String text)

Creates a snippet with a specified body text. Title is automatically generated from the first 20 characters in the text, with ellipsis added if the length exceeds 20 characters.

Parameters:

text - body text, may contain HTML markup

Snippet

public Snippet(String title,
               String text)

Creates a snippet with a specified title and text. The title can be of arbitrary length. The body text may contain HTML markup.

Parameters:

title - title of the Snippet. May be of arbitrary length.

text - body text, may contain HTML markup

Method Detail

getTitle

public String getTitle()

Get the set title text (either a user-specified string or up to 20 characters of the main snippet text.

Returns:

a string

getText

public String getText()

Get the snippet content text.

Returns:

a string