Package com.vaadin.componentfactory

Class Breadcrumb

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.littemplate.LitTemplate
com.vaadin.componentfactory.Breadcrumb
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.internal.Template, Serializable
@Tag("vcf-breadcrumb") @NpmPackage(value="@vaadin-component-factory/vcf-breadcrumb", version="3.0.0") @JsModule("@vaadin-component-factory/vcf-breadcrumb/dist/src/vcf-breadcrumbs.js") public class Breadcrumb extends com.vaadin.flow.component.littemplate.LitTemplate
Server-side component for the vcf-breadcrumb element.
Author:
Vaadin Ltd
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Breadcrumb(String text)
    Creates instance of Breadcrumb with text set.
    Breadcrumb(String text, String href)
    Creates instance of Breadcrumb with text and href defined.
    Breadcrumb(String text, String href, boolean collapse)
    Creates an instance of Breadcrumb with text, href and collapse option defined.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getCollapse()
    Gets wheter the breadcrumb is collapsible or not.
    String
    getHref()
     
    String
    getText()
     
    void
    setCollapse(boolean collapse)
    Setting collapse "true" to indicate breadcrumb is collapsible This means that the breadcrumb will srink and show its label with ellipsis when the space available is not enough to display it completely.
    void
    setHref(String href)
    Setting href for breadcrumb
    void
    setText(String text)
    Setting text of breadcrumb

    Methods inherited from class com.vaadin.flow.component.littemplate.LitTemplate

    getChildren

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

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

    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

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Constructor Details

    • Breadcrumb

      public Breadcrumb(String text)
      Creates instance of Breadcrumb with text set.
      Parameters:
      text - text of breadcrumb

    • Breadcrumb

      public Breadcrumb(String text, String href)
      Creates instance of Breadcrumb with text and href defined.
      Parameters:
      text - text of breadcrumb
      href - URL or a URL fragment that the breadcrumb points to

    • Breadcrumb

      public Breadcrumb(String text, String href, boolean collapse)
      Creates an instance of Breadcrumb with text, href and collapse option defined.
      Parameters:
      text - text of breadcrumb
      href - URL or a URL fragment that the breadcrumb points to
      collapse - true to make the breadcrumb collapsible

  • Method Details

    • setText

      public void setText(String text)
      Setting text of breadcrumb
      Parameters:
      text - text of breadcrumb

    • getText

      public String getText()
      Returns:
      of breadcrumb

    • getHref

      public String getHref()
      Returns:
      href of breadcrumb

    • setHref

      public void setHref(String href)
      Setting href for breadcrumb
      Parameters:
      href - URL or a URL fragment that the breadcrumb points to

    • getCollapse

      public boolean getCollapse()
      Gets wheter the breadcrumb is collapsible or not.
      Returns:
      collapse value of breadcrumb

    • setCollapse

      public void setCollapse(boolean collapse)
      Setting collapse "true" to indicate breadcrumb is collapsible This means that the breadcrumb will srink and show its label with ellipsis when the space available is not enough to display it completely.
      Parameters:
      collapse - true to make the breadcrumb collapsible