Package com.ptc.mvc.components

Interface InfoConfig

All Superinterfaces:
ComponentConfig, CustomizableViewConfig
All Known Implementing Classes:
JcaInfoConfig, JcaMiniInfoConfig
public interface InfoConfig extends CustomizableViewConfig
Describes an information page
Supported API: true

Extendable: false

  • Method Details

    • getActionListName

      String getActionListName()
      Returns the action model to use for the actions list. The default action model to use is determined by the menu for attribute in actionmodels.xml.

      Supported API: true
      Returns:
      String

    • setActionListName

      void setActionListName(String actionListName)
      sets the action model to be used for the actions list.

      Supported API: true
      Parameters:
      actionListName -

    • isMiniInfoPage

      boolean isMiniInfoPage()
      checks the miniInfo Page attribute. If found true the visualization and action model is not rendered.

      Supported API: true
      Returns:
      boolean

    • setMiniInfoPage

      void setMiniInfoPage(boolean miniInfoPage)
      sets the miniInfo Page attribute. If found true the visualization and action model is not rendered.

      Supported API: true
      Parameters:
      miniInfoPage -

    • getNavBarName

      String getNavBarName()
      returns the action model to use for the third level nav bar. There is no default nav bar.

      Supported API: true
      Returns:
      String

    • setNavBarName

      void setNavBarName(String navBar)
      sets the action model to use for the third level nav bar. There is no default nav bar.

      Supported API: true
      Parameters:
      navBar -

    • getTabSet

      String getTabSet()
      Returns the name of the action model used for the tabset.

      Supported API: true
      Returns:
      String

    • setTabSet

      void setTabSet(String tabSet)
      Sets the name of the action model to use for the tabset.

      Supported API: true
      Parameters:
      tabSet -

    • setTabSetKey

      void setTabSetKey(String tabSetKey)
      Sets the tabSetKey to use for this info page. This tabSetKey will form the basis for saving tab order, tab content and the last active tab. If no tabSetKey is specified by the builder the hard type of the business object will be used as the tabSetKey. For example, part info page will end up using a tab set key of "wt.part.WTPart". Some info pages change this tabSetKey to share behavior across types. For example, the caddoc and saved caddoc info pages will both have tabSetKey of "wt.epm.EPMDocument". Other info pages change this tabSetKey to get different behavior for the same type. For example, the 'Clash Job Definition' info page will have a different tabSetKey so that tabs/tables added to that page are not added to the Document info page. Recommended tab set keys would be like:
      1. "wt.part.WTPart" (type name)
      2. "WCTYPE|wt.part.WTPart|com.acme.SoftPart" (external form - for customizers)
      3. "SoftPart" (type name without domain - for OOTB soft types that we don't know the external form for yet)
      Be careful with these keys from release to release. Since they are persisted to the database a migrator will be needed if the key needs to change.

      Supported API: true

    • setHideAddNewTab

      void setHideAddNewTab(boolean hide)
      Used to configure whether or not to show the '+' tab (new tab) for an info page.
      Parameters:
      hide - true to hide the tab, false to show. Defaults to false.

      Supported API: true

    • getHideAddNewTab

      boolean getHideAddNewTab()
      Used to get the value of whether or not to show the '+' tab (new tab) for an info page.
      Returns:
      boolean

      Supported API: true