Class AbstractVisualAction<W extends com.vaadin.flow.component.Component>

    • Field Detail

      • icon

        protected com.vaadin.flow.component.icon.Icon icon
        Icon for buttons, menu entries, widget cards, etc. SVG images are encouraged, because they can be easily rescaled.
      • formatOptions

        protected Properties formatOptions
        Settings useful to renderer to display the action. Currently suggested and supported options: bold (boolean) and color (HTML hex RGB value, including #).
      • childrenActions

        protected List<AbstractAction> childrenActions
        In case this is a composed action with sub-actions.
      • moduleId

        protected String moduleId
        The module the actions belongs to.
    • Constructor Detail

      • AbstractVisualAction

        public AbstractVisualAction​(String moduleId)
    • Method Detail

      • getIcon

        public com.vaadin.flow.component.icon.Icon getIcon()
      • setIcon

        public void setIcon​(com.vaadin.flow.component.icon.Icon icon)
      • getFormatOptions

        public Properties getFormatOptions()
      • setFormatOptions

        public void setFormatOptions​(Properties formatOptions)
      • setChildrenActions

        public void setChildrenActions​(List<AbstractAction> childrenActions)
      • clearListeners

        public void clearListeners()
      • getModuleId

        public String getModuleId()
      • setModuleId

        public void setModuleId​(String moduleId)
      • getVisualComponent

        public abstract W getVisualComponent​(ModuleActionParameterSet parameters)
        The visual component (a XXLayout, for example), to be embedded in a Dialog upon triggering the action.
        Parameters:
        parameters - The initial parameters necessary to build the visual component. Some or all these parameters might be later passed to the underlying AbstractAction.
        Returns:
        The visual component.
      • getModuleAction

        public abstract AbstractAction getModuleAction()
        The underlying action wrapped by this visual object.
        Returns:
        The action.