Package io.jmix.flowui.kit.component.main

Class UserIndicator<V>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.Composite<com.vaadin.flow.component.html.Div>
io.jmix.flowui.kit.component.main.UserIndicator<V>
Type Parameters:
V - value type
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, HasTitle, SupportsFormatter<V>, Serializable
Direct Known Subclasses:
JmixUserIndicator
public class UserIndicator<V> extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.html.Div> implements SupportsFormatter<V>, HasTitle, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasEnabled
Displays information about the current user. If the user substitution is set up, a dropdown list of users available for substitution is displayed.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
    USER_INDICATOR_CLASS_NAME
     
    protected static final String
    USER_INDICATOR_LABEL_CLASS_NAME
     
    protected com.vaadin.flow.component.Component
    userComponent
     
    protected Formatter<? super V>
    userFormatter
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    UserIndicator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected com.vaadin.flow.component.html.Span
    createUserIndicator()
     
    protected String
    generateUserTitle(V user)
     
    Formatter<V>
    getFormatter()
     
    protected com.vaadin.flow.component.html.Div
    initContent()
     
    void
    refreshUser()
    Updates user information displayed by the component.
    void
    setFormatter(Formatter<? super V> formatter)
    Sets a formatter that is used to produce the strings representation of the value.
    protected void
    updateUserIndicatorLabel(V user)
     

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

    getChildren, getContent, getElement

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

    addListener, findAncestor, fireEvent, from, get, 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.HasEnabled

    isEnabled, setEnabled

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

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

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

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

    Methods inherited from interface io.jmix.flowui.kit.component.HasTitle

    getTitle, setTitle

  • Field Details

    • USER_INDICATOR_CLASS_NAME

      protected static final String USER_INDICATOR_CLASS_NAME
      See Also:

    • USER_INDICATOR_LABEL_CLASS_NAME

      protected static final String USER_INDICATOR_LABEL_CLASS_NAME
      See Also:

    • userComponent

      protected com.vaadin.flow.component.Component userComponent

    • userFormatter

      protected Formatter<? super V> userFormatter

  • Constructor Details

    • UserIndicator

      public UserIndicator()

  • Method Details

    • initContent

      protected com.vaadin.flow.component.html.Div initContent()
      Overrides:
      initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.html.Div>

    • refreshUser

      public void refreshUser()
      Updates user information displayed by the component.

    • updateUserIndicatorLabel

      protected void updateUserIndicatorLabel(V user)

    • createUserIndicator

      protected com.vaadin.flow.component.html.Span createUserIndicator()

    • generateUserTitle

      protected String generateUserTitle(V user)

    • getFormatter

      @Nullable public Formatter<V> getFormatter()
      Specified by:
      getFormatter in interface SupportsFormatter<V>
      Returns:
      a formatter or null if not set

    • setFormatter

      public void setFormatter(@Nullable Formatter<? super V> formatter)
      Description copied from interface: SupportsFormatter
      Sets a formatter that is used to produce the strings representation of the value.
      Specified by:
      setFormatter in interface SupportsFormatter<V>
      Parameters:
      formatter - a formatter to set or null to remove