Package io.jmix.ui.widget

Class JmixTagContainer<V>

java.lang.Object
com.vaadin.server.AbstractClientConnector
com.vaadin.ui.AbstractComponent
com.vaadin.ui.AbstractComponentContainer
com.vaadin.ui.AbstractLayout
com.vaadin.ui.CssLayout
io.jmix.ui.widget.JmixTagContainer<V>
Type Parameters:
V - value type
All Implemented Interfaces:
com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, Serializable, Iterable<com.vaadin.ui.Component>
public class JmixTagContainer<V> extends com.vaadin.ui.CssLayout
Container for JmixTagLabel.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector

    com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

    Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

    com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

    Nested classes/interfaces inherited from interface com.vaadin.ui.Component

    com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.Component.Listener

    Nested classes/interfaces inherited from interface com.vaadin.ui.Component.HasContextHelp

    com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListener

    Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

    com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

    Nested classes/interfaces inherited from interface com.vaadin.ui.Layout

    com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

    Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

    com.vaadin.server.Sizeable.Unit

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    editable
     
    protected com.google.common.collect.BiMap<V,JmixTagLabel>
    itemComponent
     
    protected List<V>
    items
     
    protected Consumer<V>
    removeTagHandler
     
    protected Function<V,String>
    tagCaptionProvider
     
    protected Consumer<V>
    tagClickHandler
     
    protected Comparator<? super V>
    tagComparator
     
    static final String
    TAGCONTAINER_INLINE_STYLENAME
     
    static final String
    TAGCONTAINER_READONLY_STYLENAME
     
    static final String
    TAGCONTAINER_STYLENAME
     
    static final String
    TAGCONTAINER_VERTICAL_STYLENAME
     
    protected Function<? super V,String>
    tagStyleProvider
     

    Fields inherited from class com.vaadin.ui.CssLayout

    components

    Fields inherited from class com.vaadin.ui.AbstractComponent

    componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredError

    Fields inherited from interface com.vaadin.server.Sizeable

    SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

  • Constructor Summary

    Constructors
    Constructor
    Description
    JmixTagContainer()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected JmixTagLabel
    createTagLabel()
     
    protected void
    doRefreshTags(Collection<V> itemsToShow)
     
    Comparator<? super V>
    getTagComparator()
     
    Function<? super V,String>
    getTagStyleProvider()
     
    boolean
    isEditable()
     
    boolean
    isInlineTags()
     
    protected void
    onTagLabelClick(JmixTagLabel label)
     
    protected void
    onTagLabelRemove(JmixTagLabel label)
     
    void
    refreshTags()
     
    void
    setEditable(boolean editable)
     
    void
    setInlineTags(boolean inline)
     
    void
    setRemoveTagHandler(Consumer<V> removeTagHandler)
     
    void
    setTagCaptionProvider(Function<V,String> tagCaptionProvider)
     
    void
    setTagClickHandler(Consumer<V> tagClickHandler)
     
    void
    setTagComparator(Comparator<? super V> comparator)
     
    void
    setTagStyleProvider(Function<? super V,String> tagStyleProvider)
     
    void
    showTags(Collection<V> itemsToShow)
     

    Methods inherited from class com.vaadin.ui.CssLayout

    addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, beforeClientResponse, getComponent, getComponentCount, getComponentIndex, getCss, getState, getState, iterator, readDesign, removeComponent, removeLayoutClickListener, replaceComponent, writeDesign

    Methods inherited from class com.vaadin.ui.AbstractLayout

    isRequiredIndicatorVisible, readMargin, setRequiredIndicatorVisible, writeMargin

    Methods inherited from class com.vaadin.ui.AbstractComponentContainer

    addComponentAttachListener, addComponentDetachListener, addComponents, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, setHeight, setWidth

    Methods inherited from class com.vaadin.ui.AbstractComponent

    addContextClickListener, addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, attach, detach, ensureContextHelpInitialized, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireContextHelpClick, focus, getActionManager, getCaption, getComponentError, getComponentErrorProvider, getContextHelpText, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getRequiredError, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isContextHelpTextHtmlEnabled, isEnabled, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setComponentErrorProvider, setContextHelpText, setContextHelpTextHtmlEnabled, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setJTestId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredError, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined

    Methods inherited from class com.vaadin.server.AbstractClientConnector

    addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getIncorrectConcurrentAccessHandler, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setConnectorResource, setErrorHandler, setIncorrectConcurrentAccessHandler, setResource, updateDiffstate

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.vaadin.server.ClientConnector

    addAttachListener, addDetachListener, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

    Methods inherited from interface com.vaadin.ui.Component

    addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setJTestId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

    Methods inherited from interface com.vaadin.ui.ComponentContainer

    addComponents, getComponentIterator, moveComponentsFrom, removeAllComponents

    Methods inherited from interface com.vaadin.shared.Connector

    getConnectorId

    Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

    addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface com.vaadin.server.Sizeable

    getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

  • Field Details

    • TAGCONTAINER_STYLENAME

      public static final String TAGCONTAINER_STYLENAME
      See Also:

    • TAGCONTAINER_READONLY_STYLENAME

      public static final String TAGCONTAINER_READONLY_STYLENAME
      See Also:

    • TAGCONTAINER_INLINE_STYLENAME

      public static final String TAGCONTAINER_INLINE_STYLENAME
      See Also:

    • TAGCONTAINER_VERTICAL_STYLENAME

      public static final String TAGCONTAINER_VERTICAL_STYLENAME
      See Also:

    • items

      protected List<V> items

    • tagCaptionProvider

      protected Function<V,String> tagCaptionProvider

    • tagStyleProvider

      protected Function<? super V,String> tagStyleProvider

    • tagClickHandler

      protected Consumer<V> tagClickHandler

    • removeTagHandler

      protected Consumer<V> removeTagHandler

    • tagComparator

      protected Comparator<? super V> tagComparator

    • editable

      protected boolean editable

    • itemComponent

      protected com.google.common.collect.BiMap<V,JmixTagLabel> itemComponent

  • Constructor Details

    • JmixTagContainer

      public JmixTagContainer()

  • Method Details

    • isEditable

      public boolean isEditable()

    • setEditable

      public void setEditable(boolean editable)

    • isInlineTags

      public boolean isInlineTags()

    • setInlineTags

      public void setInlineTags(boolean inline)

    • setTagCaptionProvider

      public void setTagCaptionProvider(Function<V,String> tagCaptionProvider)

    • getTagStyleProvider

      @Nullable public Function<? super V,String> getTagStyleProvider()

    • setTagStyleProvider

      public void setTagStyleProvider(@Nullable Function<? super V,String> tagStyleProvider)

    • setTagClickHandler

      public void setTagClickHandler(@Nullable Consumer<V> tagClickHandler)

    • setRemoveTagHandler

      public void setRemoveTagHandler(Consumer<V> removeTagHandler)

    • getTagComparator

      @Nullable public Comparator<? super V> getTagComparator()

    • setTagComparator

      public void setTagComparator(@Nullable Comparator<? super V> comparator)

    • showTags

      public void showTags(@Nullable Collection<V> itemsToShow)

    • refreshTags

      public void refreshTags()

    • doRefreshTags

      protected void doRefreshTags(Collection<V> itemsToShow)

    • createTagLabel

      protected JmixTagLabel createTagLabel()

    • onTagLabelRemove

      protected void onTagLabelRemove(JmixTagLabel label)

    • onTagLabelClick

      protected void onTagLabelClick(JmixTagLabel label)