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

Class Title

java.lang.Object
io.jmix.chartsflowui.kit.component.model.ChartObservableObject
io.jmix.chartsflowui.kit.component.model.Title
All Implemented Interfaces:
HasBorder<Title>, HasPosition<Title>, HasShadow<Title>, HasPadding<Title>, Serializable
public class Title extends ChartObservableObject implements HasShadow<Title>, HasPosition<Title>, HasPadding<Title>, HasBorder<Title>
Title component, including main title and subtitle. More detailed information is provided in the documentation.
See Also:

  • Field Details

  • Constructor Details

    • Title

      public Title()

  • Method Details

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • isShow

      public Boolean isShow()

    • setShow

      public void setShow(Boolean show)

    • getText

      public String getText()

    • setText

      public void setText(String text)

    • getLink

      public String getLink()

    • setLink

      public void setLink(String link)

    • getTarget

      public Title.Target getTarget()

    • setTarget

      public void setTarget(Title.Target target)

    • getTextStyle

      public Title.TextStyle getTextStyle()

    • setTextStyle

      public void setTextStyle(Title.TextStyle textStyle)

    • getSubtext

      public String getSubtext()

    • setSubtext

      public void setSubtext(String subtext)

    • getSublink

      public String getSublink()

    • setSublink

      public void setSublink(String sublink)

    • getSubtarget

      public Title.Target getSubtarget()

    • setSubtarget

      public void setSubtarget(Title.Target subtarget)

    • getSubtextStyle

      public Title.SubtextStyle getSubtextStyle()

    • setSubtextStyle

      public void setSubtextStyle(Title.SubtextStyle subtextStyle)

    • getTextAlign

      public Title.TextAlign getTextAlign()

    • setTextAlign

      public void setTextAlign(Title.TextAlign textAlign)

    • getTextVerticalAlign

      public Title.TextVerticalAlign getTextVerticalAlign()

    • setTextVerticalAlign

      public void setTextVerticalAlign(Title.TextVerticalAlign textVerticalAlign)

    • isTriggerEvent

      public Boolean isTriggerEvent()

    • setTriggerEvent

      public void setTriggerEvent(Boolean triggerEvent)

    • getPadding

      public Padding getPadding()
      Specified by:
      getPadding in interface HasPadding<Title>
      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<Title>
      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<Title>
      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<Title>
      Parameters:
      top - top padding to set
      right - right padding to set
      bottom - bottom padding to set
      left - left padding to set

    • getItemGap

      public Integer getItemGap()

    • setItemGap

      public void setItemGap(Integer itemGap)

    • getZLevel

      public Integer getZLevel()

    • setZLevel

      public void setZLevel(Integer zLevel)

    • getZ

      public Integer getZ()

    • setZ

      public void setZ(Integer z)

    • getLeft

      public String getLeft()
      Specified by:
      getLeft in interface HasPosition<Title>
      Returns:
      distance between component and the left side of the container

    • setLeft

      public void setLeft(String left)
      Description copied from interface: HasPosition
      Sets a distance between component and the left side of the container.
      Possible values are:
      • A pixel value like "20".
      • Percentage value relative to container width like "20%".
      • Predefined values like "left", "center", "right".
      Specified by:
      setLeft in interface HasPosition<Title>
      Parameters:
      left - distance to set

    • getTop

      public String getTop()
      Specified by:
      getTop in interface HasPosition<Title>
      Returns:
      distance between component and the top side of the container

    • setTop

      public void setTop(String top)
      Description copied from interface: HasPosition
      Sets a distance between component and the top side of the container.
      Possible values are:
      • A pixel value like "20".
      • Percentage value relative to container width like "20%".
      • Predefined values like "top", "middle", "bottom".
      Specified by:
      setTop in interface HasPosition<Title>
      Parameters:
      top - distance to set

    • getRight

      public String getRight()
      Specified by:
      getRight in interface HasPosition<Title>
      Returns:
      distance between component and the right side of the container

    • setRight

      public void setRight(String right)
      Description copied from interface: HasPosition
      Sets a distance between component and the right side of the container.
      Possible values are:
      • A pixel value like "20".
      • Percentage value relative to container width like "20%".
      Specified by:
      setRight in interface HasPosition<Title>
      Parameters:
      right - distance to set

    • getBottom

      public String getBottom()
      Specified by:
      getBottom in interface HasPosition<Title>
      Returns:
      distance between component and the bottom side of the container

    • setBottom

      public void setBottom(String bottom)
      Description copied from interface: HasPosition
      Sets a distance between component and the bottom side of the container.
      Possible values are:
      • A pixel value like "20".
      • Percentage value relative to container width like "20%".
      Specified by:
      setBottom in interface HasPosition<Title>
      Parameters:
      bottom - distance to set

    • getBackgroundColor

      public Color getBackgroundColor()

    • setBackgroundColor

      public void setBackgroundColor(Color backgroundColor)

    • getBorderColor

      public Color getBorderColor()
      Specified by:
      getBorderColor in interface HasBorder<Title>
      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<Title>
      Parameters:
      borderColor - color to set

    • getBorderWidth

      public Integer getBorderWidth()
      Specified by:
      getBorderWidth in interface HasBorder<Title>
      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<Title>
      Parameters:
      borderWidth - border width in pixels

    • getBorderRadius

      public Integer getBorderRadius()
      Specified by:
      getBorderRadius in interface HasBorder<Title>
      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<Title>
      Parameters:
      borderRadius - border radius to set in pixels

    • getShadowBlur

      public Integer getShadowBlur()
      Specified by:
      getShadowBlur in interface HasShadow<Title>
      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<Title>
      Parameters:
      shadowBlur - depth of shadow blur

    • getShadowColor

      public Color getShadowColor()
      Specified by:
      getShadowColor in interface HasShadow<Title>
      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<Title>
      Parameters:
      shadowColor - color to set

    • getShadowOffsetX

      public Integer getShadowOffsetX()
      Specified by:
      getShadowOffsetX in interface HasShadow<Title>
      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<Title>
      Parameters:
      shadowOffsetX - offset to set in pixels

    • getShadowOffsetY

      public Integer getShadowOffsetY()
      Specified by:
      getShadowOffsetY in interface HasShadow<Title>
      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<Title>
      Parameters:
      shadowOffsetY - offset to set in pixels

    • withId

      public Title withId(String id)

    • withShow

      public Title withShow(Boolean show)

    • withText

      public Title withText(String text)

    • withLink

      public Title withLink(String link)

    • withTarget

      public Title withTarget(Title.Target target)

    • withTextStyle

      public Title withTextStyle(Title.TextStyle textStyle)

    • withSubtext

      public Title withSubtext(String subtext)

    • withSublink

      public Title withSublink(String sublink)

    • withSubtarget

      public Title withSubtarget(Title.Target subtarget)

    • withSubtextStyle

      public Title withSubtextStyle(Title.SubtextStyle subtextStyle)

    • withTextAlign

      public Title withTextAlign(Title.TextAlign textAlign)

    • withTextVerticalAlign

      public Title withTextVerticalAlign(Title.TextVerticalAlign textVerticalAlign)

    • withTriggerEvent

      public Title withTriggerEvent(Boolean triggerEvent)

    • withItemGap

      public Title withItemGap(Integer itemGap)

    • withZLevel

      public Title withZLevel(Integer zLevel)

    • withZ

      public Title withZ(Integer z)

    • withBackgroundColor

      public Title withBackgroundColor(Color backgroundColor)