Package com.vaadin.flow.component

Class Text

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Text

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasStyle, HasText, Serializable

public class Text
extends Component
implements HasText

A component which encapsulates the given text in a text node.

Text node doesn't support setting any attribute or property so you may not use Element API (and Text doesn't provide any such contract) for setting attribute/property. It implies that you may not style this component as well. Any attempt to set attribute/property value throws an exception. The only available API for a Text component is set a text.

If you need a text component which can be styled then check Span class (from flow-html-components) module.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

HasText.WhiteSpace

Constructor Summary

Constructors

Constructor	Description
Text(String text)	Creates an instance using the given text.

Method Summary

Modifier and Type	Method	Description
void	addClassName(String className)	The method is not supported for the Text class.
void	addClassNames(String... classNames)	The method is not supported for the Text class.
String	getText()	Gets the text of the component.
boolean	removeClassName(String className)	The method is not supported for the Text class.
void	removeClassNames(String... classNames)	The method is not supported for the Text class.
protected <T> void	set(PropertyDescriptor<T,?> descriptor, T value)	Sets the value of the given component property.
void	setClassName(String className)	The method is not supported for the Text class.
void	setClassName(String className, boolean set)	The method is not supported for the Text class.
void	setId(String id)	The method is not supported for the Text class.
void	setText(String text)	Sets the text of the component.
void	setVisible(boolean visible)	The method is not supported for the Text class.

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, setElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasStyle

getClassName, getClassNames, getStyle, hasClassName

Methods inherited from interface com.vaadin.flow.component.HasText

getWhiteSpace, setWhiteSpace

Constructor Details

Text

public Text(String text)

Creates an instance using the given text.

Parameters:

text - the text to show, null is interpreted as an empty string

Method Details

setText

public void setText(String text)

Sets the text of the component.

Specified by:

setText in interface HasText

Parameters:

text - the text of the component, null is interpreted as an empty string

getText

public String getText()

Gets the text of the component.

Specified by:

getText in interface HasText

Returns:

the text of the component, not null

set

protected <T> void set(PropertyDescriptor<T,?> descriptor,
 T value)

Description copied from class: Component

Sets the value of the given component property.

Overrides:

set in class Component

Type Parameters:

T - type of the value to set

Parameters:

descriptor - the descriptor for the property to set, not null

value - the new property value to set

See Also:

• PropertyDescriptor

setId

public void setId(String id)

The method is not supported for the Text class.

Always throws an UnsupportedOperationException.

Overrides:

setId in class Component

Parameters:

id - the id to set, or "" to remove any previously set id

Throws:

UnsupportedOperationException - always, as text nodes cannot have IDs

setVisible

public void setVisible(boolean visible)

The method is not supported for the Text class.

Always throws an UnsupportedOperationException.

Overrides:

setVisible in class Component

Parameters:

visible - the component visibility value

Throws:

UnsupportedOperationException - always, as text nodes cannot have visibility changed

addClassName

public void addClassName(String className)

The method is not supported for the Text class.

Always throws an UnsupportedOperationException.

Specified by:

addClassName in interface HasStyle

Parameters:

className - the CSS class name to add, not null

Throws:

UnsupportedOperationException - always, as text nodes cannot have class names

removeClassName

public boolean removeClassName(String className)

The method is not supported for the Text class.

Always throws an UnsupportedOperationException.

Specified by:

removeClassName in interface HasStyle

Parameters:

className - the CSS class name to remove, not null

Returns:

true if the class name was removed, false if the class list didn't contain the class name

Throws:

UnsupportedOperationException - always, as text nodes cannot have class names

setClassName

public void setClassName(String className)

The method is not supported for the Text class.

Always throws an UnsupportedOperationException.

Specified by:

setClassName in interface HasStyle

Parameters:

className - a space-separated string of class names to set, or null to remove all class names

Throws:

UnsupportedOperationException - always, as text nodes cannot have class names

setClassName

public void setClassName(String className,
 boolean set)

The method is not supported for the Text class.

Always throws an UnsupportedOperationException.

Specified by:

setClassName in interface HasStyle

Parameters:

className - the class name to set or remove, not null

set - true to set the class name, false to remove it

Throws:

UnsupportedOperationException - always, as text nodes cannot have class names

addClassNames

public void addClassNames(String... classNames)

The method is not supported for the Text class.

Always throws an UnsupportedOperationException.

Specified by:

addClassNames in interface HasStyle

Parameters:

classNames - the CSS class name or class names to be added to the component

Throws:

UnsupportedOperationException - always, as text nodes cannot have class names

removeClassNames

public void removeClassNames(String... classNames)

The method is not supported for the Text class.

Always throws an UnsupportedOperationException.

Specified by:

removeClassNames in interface HasStyle

Parameters:

classNames - the CSS class name or class names to be removed from the component

Throws:

UnsupportedOperationException - always, as text nodes cannot have class names