Package io.jmix.chartsflowui.kit.component.model.shared

Class AbstractEnhancedLabel<T extends AbstractEnhancedLabel<T>>

java.lang.Object

io.jmix.chartsflowui.kit.component.model.ChartObservableObject

io.jmix.chartsflowui.kit.component.model.shared.AbstractText<T>

io.jmix.chartsflowui.kit.component.model.shared.AbstractRichText<T>

io.jmix.chartsflowui.kit.component.model.shared.AbstractEnhancedLabel<T>

Type Parameters:

T - origin enhanced label class type

All Implemented Interfaces:

HasAlign<T>, HasBorder<T>, HasShadow<T>, HasText<T>, HasPadding<T>, Serializable

Direct Known Subclasses:

AbstractLegend.SelectorLabel, Label, LineSeries.EndLabel

public abstract class AbstractEnhancedLabel<T extends AbstractEnhancedLabel<T>>
extends AbstractRichText<T>
implements HasShadow<T>, HasBorder<T>, HasAlign<T>, HasPadding<T>

The base class for enhanced label.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject

ChartObservableObject.ObjectChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Align	align
protected Color	backgroundColor
protected Color	borderColor
protected Integer	borderDashOffset
protected Integer	borderRadius
protected String	borderType
protected Integer	borderWidth
protected Integer	distance
protected Integer[]	offset
protected Padding	padding
protected Integer	rotate
protected Integer	shadowBlur
protected Color	shadowColor
protected Integer	shadowOffsetX
protected Integer	shadowOffsetY
protected Boolean	show
protected VerticalAlign	verticalAlign

Fields inherited from class io.jmix.chartsflowui.kit.component.model.shared.AbstractRichText

richStyles

Fields inherited from class io.jmix.chartsflowui.kit.component.model.shared.AbstractText

color, ellipsis, fontFamily, fontSize, fontStyle, fontWeight, height, lineHeight, overflow, textBorderColor, textBorderDashOffset, textBorderType, textBorderWidth, textShadowBlur, textShadowColor, textShadowOffsetX, textShadowOffsetY, width

Fields inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject

children, dirty, listener

Constructor Summary

Constructors

Constructor	Description
AbstractEnhancedLabel()

Method Summary

Modifier and Type	Method	Description
@Nullable Align	getAlign()
@Nullable Color	getBackgroundColor()
@Nullable Color	getBorderColor()
@Nullable Integer	getBorderDashOffset()
@Nullable Integer	getBorderRadius()
@Nullable String	getBorderType()
@Nullable Integer	getBorderWidth()
@Nullable Integer	getDistance()
@Nullable Integer[]	getOffset()
@Nullable Padding	getPadding()
@Nullable Integer	getRotate()
@Nullable Integer	getShadowBlur()
@Nullable Color	getShadowColor()
@Nullable Integer	getShadowOffsetX()
@Nullable Integer	getShadowOffsetY()
@Nullable Boolean	getShow()
@Nullable VerticalAlign	getVerticalAlign()
void	setAlign(Align align)	Sets horizontal alignment of component or replaces an existing one.
void	setBackgroundColor(Color backgroundColor)
void	setBorderColor(Color borderColor)	Sets a border color or replaces an existing one.
void	setBorderDashOffset(Integer borderDashOffset)
void	setBorderRadius(Integer borderRadius)	Sets a border radius of the text fragment or replaces an existing one.
void	setBorderType(String borderType)
void	setBorderWidth(Integer borderWidth)	Sets a border width or replaces an existing one.
void	setDistance(Integer distance)
void	setOffset(Integer horizontal, Integer vertical)
void	setPadding(Integer padding)	Sets padding on each of the four sides or replaces an existing one.
void	setPadding(Integer vertical, Integer horizontal)	Sets the top/bottom and left/right paddings or replaces an existing one.
void	setPadding(Integer top, Integer right, Integer bottom, Integer left)	Sets each of the four paddings separately.
void	setRotate(Integer rotate)
void	setShadowBlur(Integer shadowBlur)	Sets depth of shadow blur or replaces an existing one.
void	setShadowColor(Color shadowColor)	Sets a color for shadow or replaces an existing one.
void	setShadowOffsetX(Integer shadowOffsetX)	Sets horizontal offset for shadow or replaces an existing one.
void	setShadowOffsetY(Integer shadowOffsetY)	Sets vertical offset for shadow or replaces an existing one.
void	setShow(Boolean show)
void	setVerticalAlign(VerticalAlign verticalAlign)	Sets vertical alignment of component or replaces an existing one.
T	withBackgroundColor(Color backgroundColor)
T	withBorderDashOffset(Integer borderDashOffset)
T	withBorderType(String borderType)
T	withDistance(Integer distance)
T	withOffset(Integer horizontal, Integer vertical)
T	withRotate(Integer rotate)
T	withShow(Boolean show)

Methods inherited from class io.jmix.chartsflowui.kit.component.model.shared.AbstractRichText

addRichStyle, getRichStyles, removeRichStyle, withRichStyle

Methods inherited from class io.jmix.chartsflowui.kit.component.model.shared.AbstractText

getColor, getEllipsis, getFontFamily, getFontSize, getFontStyle, getFontWeight, getHeight, getLineHeight, getOverflow, getTextBorderColor, getTextBorderDashOffset, getTextBorderType, getTextBorderWidth, getTextShadowBlur, getTextShadowColor, getTextShadowOffsetX, getTextShadowOffsetY, getWidth, setColor, setEllipsis, setFontFamily, setFontSize, setFontStyle, setFontWeight, setHeight, setLineHeight, setOverflow, setTextBorderColor, setTextBorderDashOffset, setTextBorderType, setTextBorderWidth, setTextShadowBlur, setTextShadowColor, setTextShadowOffsetX, setTextShadowOffsetY, setWidth, withColor, withEllipsis, withFontFamily, withFontSize, withFontStyle, withFontWeight, withHeight, withLineHeight, withOverflow, withWidth

Methods inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject

addChild, fireChangeEvent, getChildren, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setChartObjectChangeListener, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.chartsflowui.kit.component.model.HasAlign

withAlign, withVerticalAlign

Methods inherited from interface io.jmix.chartsflowui.kit.component.model.HasBorder

withBorderColor, withBorderRadius, withBorderWidth

Methods inherited from interface io.jmix.chartsflowui.kit.component.model.shared.HasPadding

withPadding, withPadding, withPadding

Methods inherited from interface io.jmix.chartsflowui.kit.component.model.HasShadow

withShadowBlur, withShadowColor, withShadowOffsetX, withShadowOffsetY

Methods inherited from interface io.jmix.chartsflowui.kit.component.model.HasText

withTextBorderColor, withTextBorderDashOffset, withTextBorderType, withTextBorderWidth, withTextShadowBlur, withTextShadowColor, withTextShadowOffsetX, withTextShadowOffsetY

Field Details

show

protected Boolean show

distance

protected Integer distance

rotate

protected Integer rotate

offset

protected Integer[] offset

align

protected Align align

verticalAlign

protected VerticalAlign verticalAlign

backgroundColor

protected Color backgroundColor

borderColor

protected Color borderColor

borderWidth

protected Integer borderWidth

borderType

protected String borderType

borderDashOffset

protected Integer borderDashOffset

borderRadius

protected Integer borderRadius

padding

protected Padding padding

shadowColor

protected Color shadowColor

shadowBlur

protected Integer shadowBlur

shadowOffsetX

protected Integer shadowOffsetX

shadowOffsetY

protected Integer shadowOffsetY

Constructor Details

AbstractEnhancedLabel

public AbstractEnhancedLabel()

Method Details

getShow

public @Nullable Boolean getShow()

setShow

public void setShow(Boolean show)

getDistance

public @Nullable Integer getDistance()

setDistance

public void setDistance(Integer distance)

getRotate

public @Nullable Integer getRotate()

setRotate

public void setRotate(Integer rotate)

getOffset

public @Nullable Integer[] getOffset()

setOffset

public void setOffset(Integer horizontal,
 Integer vertical)

getAlign

public @Nullable Align getAlign()

Specified by:

getAlign in interface HasAlign<T extends AbstractEnhancedLabel<T>>

Returns:

horizontal alignment of component

setAlign

public void setAlign(Align align)

Description copied from interface: HasAlign

Sets horizontal alignment of component or replaces an existing one.

Specified by:

setAlign in interface HasAlign<T extends AbstractEnhancedLabel<T>>

Parameters:

align - alignment to set

getVerticalAlign

public @Nullable VerticalAlign getVerticalAlign()

Specified by:

getVerticalAlign in interface HasAlign<T extends AbstractEnhancedLabel<T>>

Returns:

vertical alignment of component

setVerticalAlign

public void setVerticalAlign(VerticalAlign verticalAlign)

Description copied from interface: HasAlign

Sets vertical alignment of component or replaces an existing one.

Specified by:

setVerticalAlign in interface HasAlign<T extends AbstractEnhancedLabel<T>>

Parameters:

verticalAlign - alignment to set

getBackgroundColor

public @Nullable Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

getBorderColor

public @Nullable Color getBorderColor()

Specified by:

getBorderColor in interface HasBorder<T extends AbstractEnhancedLabel<T>>

Returns:

border color

setBorderColor

public void setBorderColor(Color borderColor)

Description copied from interface: HasBorder

Sets a border color or replaces an existing one.

Specified by:

setBorderColor in interface HasBorder<T extends AbstractEnhancedLabel<T>>

Parameters:

borderColor - color to set

getBorderWidth

public @Nullable Integer getBorderWidth()

Specified by:

getBorderWidth in interface HasBorder<T extends AbstractEnhancedLabel<T>>

Returns:

border width in pixels

setBorderWidth

public void setBorderWidth(Integer borderWidth)

Description copied from interface: HasBorder

Sets a border width or replaces an existing one.

Specified by:

setBorderWidth in interface HasBorder<T extends AbstractEnhancedLabel<T>>

Parameters:

borderWidth - border width in pixels

getBorderType

public @Nullable String getBorderType()

setBorderType

public void setBorderType(String borderType)

getBorderDashOffset

public @Nullable Integer getBorderDashOffset()

setBorderDashOffset

public void setBorderDashOffset(Integer borderDashOffset)

getBorderRadius

public @Nullable Integer getBorderRadius()

Specified by:

getBorderRadius in interface HasBorder<T extends AbstractEnhancedLabel<T>>

Returns:

border radius of the text fragment

setBorderRadius

public void setBorderRadius(Integer borderRadius)

Description copied from interface: HasBorder

Sets a border radius of the text fragment or replaces an existing one.

Specified by:

setBorderRadius in interface HasBorder<T extends AbstractEnhancedLabel<T>>

Parameters:

borderRadius - border radius to set in pixels

getPadding

public @Nullable Padding getPadding()

Specified by:

getPadding in interface HasPadding<T extends AbstractEnhancedLabel<T>>

Returns:

space around content

setPadding

public void setPadding(Integer padding)

Description copied from interface: HasPadding

Sets padding on each of the four sides or replaces an existing one. The unit is px.

Specified by:

setPadding in interface HasPadding<T extends AbstractEnhancedLabel<T>>

Parameters:

padding - padding to set

setPadding

public void setPadding(Integer vertical,
 Integer horizontal)

Description copied from interface: HasPadding

Sets the top/bottom and left/right paddings or replaces an existing one. The unit is px.

Specified by:

setPadding in interface HasPadding<T extends AbstractEnhancedLabel<T>>

Parameters:

vertical - top and bottom padding to set

horizontal - left and right padding to set

setPadding

public void setPadding(Integer top,
 Integer right,
 Integer bottom,
 Integer left)

Description copied from interface: HasPadding

Sets each of the four paddings separately. The unit is px.

Specified by:

setPadding in interface HasPadding<T extends AbstractEnhancedLabel<T>>

Parameters:

top - top padding to set

right - right padding to set

bottom - bottom padding to set

left - left padding to set

getShadowColor

public @Nullable Color getShadowColor()

Specified by:

getShadowColor in interface HasShadow<T extends AbstractEnhancedLabel<T>>

Returns:

shadow color

setShadowColor

public void setShadowColor(Color shadowColor)

Description copied from interface: HasShadow

Sets a color for shadow or replaces an existing one.

Specified by:

setShadowColor in interface HasShadow<T extends AbstractEnhancedLabel<T>>

Parameters:

shadowColor - color to set

getShadowBlur

public @Nullable Integer getShadowBlur()

Specified by:

getShadowBlur in interface HasShadow<T extends AbstractEnhancedLabel<T>>

Returns:

depth of shadow blur

setShadowBlur

public void setShadowBlur(Integer shadowBlur)

Description copied from interface: HasShadow

Sets depth of shadow blur or replaces an existing one.

Specified by:

setShadowBlur in interface HasShadow<T extends AbstractEnhancedLabel<T>>

Parameters:

shadowBlur - depth of shadow blur

getShadowOffsetX

public @Nullable Integer getShadowOffsetX()

Specified by:

getShadowOffsetX in interface HasShadow<T extends AbstractEnhancedLabel<T>>

Returns:

horizontal offset for shadow in pixels

setShadowOffsetX

public void setShadowOffsetX(Integer shadowOffsetX)

Description copied from interface: HasShadow

Sets horizontal offset for shadow or replaces an existing one.

Specified by:

setShadowOffsetX in interface HasShadow<T extends AbstractEnhancedLabel<T>>

Parameters:

shadowOffsetX - offset to set in pixels

getShadowOffsetY

public @Nullable Integer getShadowOffsetY()

Specified by:

getShadowOffsetY in interface HasShadow<T extends AbstractEnhancedLabel<T>>

Returns:

vertical offset for shadow in pixels

setShadowOffsetY

public void setShadowOffsetY(Integer shadowOffsetY)

Description copied from interface: HasShadow

Sets vertical offset for shadow or replaces an existing one.

Specified by:

setShadowOffsetY in interface HasShadow<T extends AbstractEnhancedLabel<T>>

Parameters:

shadowOffsetY - offset to set in pixels

withShow

public T withShow(Boolean show)

withDistance

public T withDistance(Integer distance)

withRotate

public T withRotate(Integer rotate)

withOffset

public T withOffset(Integer horizontal,
 Integer vertical)

withBackgroundColor

public T withBackgroundColor(Color backgroundColor)

withBorderType

public T withBorderType(String borderType)

withBorderDashOffset

public T withBorderDashOffset(Integer borderDashOffset)