Package io.jmix.ui.component

Interface Label<V>

Type Parameters:

V - type of value

All Superinterfaces:

Component, Component.HasDescription, Component.HasIcon, HasContextHelp, HasFormatter<V>, HasHtmlDescription, HasHtmlSanitizer, HasValue<V>, HasValueSource<V>

All Known Subinterfaces:

NotificationsIndicator

All Known Implementing Classes:

LabelImpl, NotificationsIndicatorImpl

@StudioComponent(caption="Label",
                 category="Components",
                 xmlElement="label",
                 icon="io/jmix/ui/icon/component/label.svg",
                 canvasBehaviour=LABEL,
                 canvasText="New Label",
                 canvasTextProperty="value",
                 unsupportedProperties={"enable","responsive"},
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/label.html")
public interface Label<V>
extends Component, HasValue<V>, HasValueSource<V>, HasFormatter<V>, Component.HasDescription, Component.HasIcon, HasContextHelp, HasHtmlDescription, HasHtmlSanitizer

Label component for showing non-editable short texts.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final org.springframework.core.ParameterizedTypeReference<Label<BigDecimal>>	TYPE_BIGDECIMAL
static final org.springframework.core.ParameterizedTypeReference<Label<Date>>	TYPE_DATE
static final org.springframework.core.ParameterizedTypeReference<Label<Date>>	TYPE_DATETIME
static final org.springframework.core.ParameterizedTypeReference<Label<String>>	TYPE_DEFAULT
static final org.springframework.core.ParameterizedTypeReference<Label<Double>>	TYPE_DOUBLE
static final org.springframework.core.ParameterizedTypeReference<Label<Integer>>	TYPE_INTEGER
static final org.springframework.core.ParameterizedTypeReference<Label<LocalDate>>	TYPE_LOCALDATE
static final org.springframework.core.ParameterizedTypeReference<Label<LocalDateTime>>	TYPE_LOCALDATETIME
static final org.springframework.core.ParameterizedTypeReference<Label<Long>>	TYPE_LONG
static final org.springframework.core.ParameterizedTypeReference<Label<OffsetTime>>	TYPE_OFFSETTIME
static final org.springframework.core.ParameterizedTypeReference<Label<String>>	TYPE_STRING
static final org.springframework.core.ParameterizedTypeReference<Label<Time>>	TYPE_TIME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
String	getRawValue()	Returns a string representation of the value.
boolean	isHtmlEnabled()
static <T, V> org.springframework.core.ParameterizedTypeReference<Label<T>>	of(Class<V> valueClass)
void	setHtmlEnabled(boolean htmlEnabled)

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasFormatter

getFormatter, setFormatter

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

TYPE_DEFAULT

static final org.springframework.core.ParameterizedTypeReference<Label<String>> TYPE_DEFAULT

TYPE_STRING

static final org.springframework.core.ParameterizedTypeReference<Label<String>> TYPE_STRING

TYPE_INTEGER

static final org.springframework.core.ParameterizedTypeReference<Label<Integer>> TYPE_INTEGER

TYPE_LONG

static final org.springframework.core.ParameterizedTypeReference<Label<Long>> TYPE_LONG

TYPE_DOUBLE

static final org.springframework.core.ParameterizedTypeReference<Label<Double>> TYPE_DOUBLE

TYPE_BIGDECIMAL

static final org.springframework.core.ParameterizedTypeReference<Label<BigDecimal>> TYPE_BIGDECIMAL

TYPE_DATE

static final org.springframework.core.ParameterizedTypeReference<Label<Date>> TYPE_DATE

TYPE_DATETIME

static final org.springframework.core.ParameterizedTypeReference<Label<Date>> TYPE_DATETIME

TYPE_LOCALDATE

static final org.springframework.core.ParameterizedTypeReference<Label<LocalDate>> TYPE_LOCALDATE

TYPE_LOCALDATETIME

static final org.springframework.core.ParameterizedTypeReference<Label<LocalDateTime>> TYPE_LOCALDATETIME

TYPE_TIME

static final org.springframework.core.ParameterizedTypeReference<Label<Time>> TYPE_TIME

TYPE_OFFSETTIME

static final org.springframework.core.ParameterizedTypeReference<Label<OffsetTime>> TYPE_OFFSETTIME

Method Details

of

static <T,
V>
org.springframework.core.ParameterizedTypeReference<Label<T>> of(Class<V> valueClass)

isHtmlEnabled

boolean isHtmlEnabled()

setHtmlEnabled

@StudioProperty(defaultValue="false")
void setHtmlEnabled(boolean htmlEnabled)

getRawValue

String getRawValue()

Returns a string representation of the value.