Package io.jmix.pivottableflowui.action

Class ShowPivotTableAction<E>

java.lang.Object
io.jmix.flowui.kit.action.AbstractAction
io.jmix.flowui.kit.action.BaseAction
io.jmix.flowui.action.ObservableBaseAction<SecuredBaseAction>
io.jmix.flowui.action.SecuredBaseAction
io.jmix.flowui.action.list.ListDataComponentAction<ShowPivotTableAction<E>,E>
io.jmix.pivottableflowui.action.ShowPivotTableAction<E>
All Implemented Interfaces:
ExecutableAction, SecuredAction, TargetAction<ListDataComponent<E>>, Action, HasShortcutCombination, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
@ActionType("pvttbl_showPivotTable") public class ShowPivotTableAction<E> extends ListDataComponentAction<ShowPivotTableAction<E>,E> implements org.springframework.context.ApplicationContextAware
Shows the pivot table with data from the component that implements ListDataComponent.

  • Field Details

    • ID

      public static final String ID
      See Also:

    • applicationContext

      protected org.springframework.context.ApplicationContext applicationContext

    • messages

      protected Messages messages

    • dialogs

      protected Dialogs dialogs

    • includedProperties

      protected String includedProperties

    • excludedProperties

      protected String excludedProperties

    • openMode

      protected OpenMode openMode

  • Constructor Details

    • ShowPivotTableAction

      public ShowPivotTableAction()

    • ShowPivotTableAction

      public ShowPivotTableAction(String id)

  • Method Details

    • setApplicationContext

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

    • setMessages

      @Autowired public void setMessages(Messages messages)

    • setDialogs

      @Autowired public void setDialogs(Dialogs dialogs)

    • getOpenMode

      @Nullable public OpenMode getOpenMode()
      Retrieves the open mode that specifies how a view should be displayed when the action is executed.
      Returns:
      the open mode for the view, or null if no open mode is set

    • setOpenMode

      public void setOpenMode(@Nullable OpenMode openMode)
      Sets the open mode to specify how a view should be displayed when executed. The default is OpenMode.NAVIGATION.
      Parameters:
      openMode - the desired open mode for the view, or null to unset the open mode

    • execute

      public void execute()
      Executes the action to show the pivot table.
      Specified by:
      execute in interface ExecutableAction

    • setExcludedProperties

      public void setExcludedProperties(String properties)
      Set excluded properties separated by a comma. Excluded properties will not be shown in the PivotTable.
      Parameters:
      properties - excluded properties

    • getExcludedProperties

      public String getExcludedProperties()

    • getExcludedPropertiesList

      public List<String> getExcludedPropertiesList()
      Returns:
      list with parsed excluded properties

    • setIncludedProperties

      public void setIncludedProperties(String properties)
      Sets included properties separated by a comma. Only included properties will be shown in the PivotTable.
      Parameters:
      properties - included properties

    • getIncludedProperties

      public String getIncludedProperties()

    • getIncludedPropertiesList

      public List<String> getIncludedPropertiesList()
      Returns:
      list with parsed included properties

    • needShowAll

      protected boolean needShowAll()
      Specifies whether to show all rows or prompt the user to select rows.
      Returns:
      true if all rows should be displayed, false otherwise

    • parseProperties

      protected List<String> parseProperties(@Nullable String properties)

    • showPivotTable

      protected void showPivotTable(ShowPivotTableAction.ShowPivotTableMode mode)