Package com.ptc.mvc.components

Interface TableConfig

All Superinterfaces:
BasicTableConfig, ComponentConfig, CustomizableViewConfig
All Known Subinterfaces:
TreeConfig
All Known Implementing Classes:
JcaInfoConfig, JcaMiniInfoConfig, com.ptc.jca.mvc.components.JcaPropertyPanelConfig, JcaTableConfig, JcaTreeConfig
public interface TableConfig extends BasicTableConfig
Describes a table component
Supported API: true

Extendable: false

  • Method Details

    • getDisableAction

      String getDisableAction()
      Get the disableAction for this component

      Supported API: true
      Returns:
      String

    • setDisableAction

      void setDisableAction(String disableAction)
      Set the disableAction for this component

      Supported API: true
      Parameters:
      disableAction -

    • getMenubarName

      String getMenubarName()
      Get the name of the action model used for menubar actions

      Supported API: true
      Returns:

    • setMenubarName

      void setMenubarName(String menubarName)
      Set the name of the action model used for menubar actions

      Supported API: true
      Parameters:
      menubarName -

    • isFreezable

      boolean isFreezable()
      Whether the component is marked for column freeze.

      Supported API: true
      Returns:

    • setFreezable

      void setFreezable(boolean freezable)
      Set the component to be considered for column freezing. Defaults to false.
      For configurable tables, the value will be overridden by the value defined in table view

      Supported API: true
      Parameters:
      freezable -

    • isRowBasedObjectHandle

      boolean isRowBasedObjectHandle()
      Whether objectHandles are needed for each row

      Supported API: true
      Returns:

    • setRowBasedObjectHandle

      void setRowBasedObjectHandle(boolean rowBasedObjectHandle)
      Set whether objectHandles are needed for each row. Defaults to false. Set to true to render a table for creating/editing multiple objects in a create/edit wizard. (applicable only in CREATE/EDIT mode)

      Supported API: true
      Parameters:
      rowBasedObjectHandle -

    • isShowCustomViewLink

      boolean isShowCustomViewLink()
      Whether to show The customize view link in the view drop down.

      Supported API: true
      Returns:

    • setShowCustomViewLink

      void setShowCustomViewLink(boolean showCustomViewLink)
      Set to show The customize view link in the view drop down. Defaults to true

      Supported API: true
      Parameters:
      showCustomViewLink -

    • isSelectable

      boolean isSelectable()
      Whether the table is selectable.

      Supported API: true
      Returns:

    • setSelectable

      void setSelectable(boolean selectable)
      Set whether the table is selectable. Defaults to true

      Supported API: true
      Parameters:
      selectable -

    • isSingleSelect

      boolean isSingleSelect()
      Whether in Single Select mode.

      Supported API: true
      Returns:
      boolean

    • setSingleSelect

      void setSingleSelect(boolean singleSelect)
      Set whether in Single Select mode. [true= radio buttons, false = check boxes] Defaults to false.

      Supported API: true
      Parameters:
      singleSelect -

    • isSingleViewOnly

      boolean isSingleViewOnly()
      Whether the component is of singleView only. Defaults to false

      Supported API: true
      Returns:
      boolean

    • setSingleViewOnly

      void setSingleViewOnly(boolean singleViewOnly)
      Set whether component is singleViewOnly. If true and table is configurable, then the table view edit wizard is launched directly from the table, as opposed to launching the table view manager. This is useful when the table does not support views, but still needs to allow the user to select columns and sort order. Defaults to false

      Supported API: true
      Parameters:
      singleViewOnly -

    • isConfigurable

      boolean isConfigurable()
      Whether the component supports configurable views.

      Supported API: true
      Returns:
      boolean

    • setConfigurable

      void setConfigurable(boolean configurable)
      Set whether this table supports configurable views. Defaults to false.
      If the builder that provides this table is of ConfigurableTableBuilder, the value will be overridden to true

      Supported API: true
      Parameters:
      configurable -

    • getGroupBy

      String getGroupBy()
      Returns the groupBy attribute of a TableConfig. This is the column that is being grouped on.

      Supported API: true
      Returns:
      String The id of the column added to this table

    • setGroupBy

      void setGroupBy(String groupByColumn)
      Set the groupBy attribute of a TableConfig. This is the column that is being grouped on.

      Supported API: true
      Parameters:
      String - The id of the column added to this table

    • setFindInTableMode

      void setFindInTableMode(FindInTableMode mode)
      Set the find in table mode Supported API: true
      Parameters:
      mode -

    • getStrikeThroughColumn

      ColumnConfig getStrikeThroughColumn()
      Returns the column which will get used for row strike-through.

      Supported API: true
      Returns:
      String The id of the column

    • setStrikeThroughColumn

      void setStrikeThroughColumn(ColumnConfig column)
      Set the column which will get used for row strike-through.

      Supported API: true
      Parameters:
      String - The id of the column

    • setNonSelectableColumn

      void setNonSelectableColumn(ColumnConfig nonSelectableColumn)
      Set whether the column is non-selectable or not
      Supported API: true
      Parameters:
      nonSelectableColumn - nonSelectableColumn=true: renders the column as non-selectable nonSelectableColumn=false; renders the column as selectable.

    • setPreSelectableColumn

      void setPreSelectableColumn(ColumnConfig preSelectableColumn)
      Set whether the column is pre-selectable or not
      Supported API: true
      Parameters:
      preSelectableColumn - preSelectableColumn=true: renders the column as pre-selectable preSelectableColumn=false; renders the column as non pre-selectable.