Package io.jmix.dashboard.component

Class JmixDashboard

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.dashboard.Dashboard
io.jmix.dashboard.component.JmixDashboard
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.dashboard.HasWidgets, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.dashboard.DashboardVariant>, ComponentContainer, HasSubParts, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
public class JmixDashboard extends com.vaadin.flow.component.dashboard.Dashboard implements HasSubParts, ComponentContainer, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean
JmixDashboard is a specialized implementation of the Dashboard component that provides additional functionality such as initializing internationalized messages and retrieving subparts by their unique identifiers.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.flow.component.dashboard.Dashboard

    com.vaadin.flow.component.dashboard.Dashboard.DashboardI18n

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.springframework.context.ApplicationContext
    applicationContext
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    JmixDashboard()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    afterPropertiesSet()
     
    protected Object
    findById(Stream<com.vaadin.flow.component.Component> components, String name)
     
    Optional<com.vaadin.flow.component.Component>
    findOwnComponent(String id)
    Finds a component within immediate children of the container by its unique identifier.
    Collection<com.vaadin.flow.component.Component>
    getOwnComponents()
    Returns a collection of components that are direct children (immediate descendants) of the container.
    Object
    getSubPart(String name)
    Returns a sub part object by its name.
    protected void
    initI18n()
     
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     

    Methods inherited from class com.vaadin.flow.component.dashboard.Dashboard

    add, addItemMovedListener, addItemMoveModeChangedListener, addItemRemovedListener, addItemResizedListener, addItemResizeModeChangedListener, addItemSelectedChangedListener, addSection, addSection, addSection, addWidgetAtIndex, getChildren, getGap, getI18n, getMaximumColumnCount, getMaximumColumnWidth, getMinimumColumnWidth, getMinimumRowHeight, getPadding, getWidgets, isDenseLayout, isEditable, isVisible, onAttach, remove, remove, removeAll, setDenseLayout, setEditable, setGap, setI18n, setMaximumColumnCount, setMaximumColumnWidth, setMinimumColumnWidth, setMinimumRowHeight, setPadding, setRootHeadingLevel, setVisible

    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, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId

    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 io.jmix.flowui.component.ComponentContainer

    findComponent, getComponent, getComponents, getOwnComponent

    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.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 com.vaadin.flow.component.HasTheme

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

    Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

    addThemeVariants, removeThemeVariants

    Methods inherited from interface com.vaadin.flow.component.dashboard.HasWidgets

    add, remove

  • Field Details

    • applicationContext

      protected org.springframework.context.ApplicationContext applicationContext

  • Constructor Details

    • JmixDashboard

      public JmixDashboard()

  • Method Details

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware
      Throws:
      org.springframework.beans.BeansException

    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      Exception

    • initI18n

      protected void initI18n()

    • getSubPart

      @Nullable public Object getSubPart(String name)
      Description copied from interface: HasSubParts
      Returns a sub part object by its name.
      Specified by:
      getSubPart in interface HasSubParts
      Parameters:
      name - sub part name, e.g. component id
      Returns:
      a sub part object by its name, or null if not found

    • findById

      @Nullable protected Object findById(Stream<com.vaadin.flow.component.Component> components, String name)

    • findOwnComponent

      public Optional<com.vaadin.flow.component.Component> findOwnComponent(String id)
      Description copied from interface: ComponentContainer
      Finds a component within immediate children of the container by its unique identifier.
      Specified by:
      findOwnComponent in interface ComponentContainer
      Parameters:
      id - the unique identifier of the component to find
      Returns:
      an Optional containing the found component if it exists within the immediate children of the container, or an empty Optional if no component with the given identifier is found

    • getOwnComponents

      public Collection<com.vaadin.flow.component.Component> getOwnComponents()
      Description copied from interface: ComponentContainer
      Returns a collection of components that are direct children (immediate descendants) of the container.
      Specified by:
      getOwnComponents in interface ComponentContainer
      Returns:
      a collection of Component instances representing the immediate children of the container, or an empty collection if no such components exist