Package com.ptc.mvc.components

Interface ComponentConfig

All Known Subinterfaces:
AttributeConfig, AttributePanelConfig, BasicTableConfig, ColumnConfig, CustomizableViewConfig, GroupConfig, InfoConfig, JcaComponentConfig, MiniTableConfig, PropertyConfig, TableConfig, TreeConfig
All Known Implementing Classes:
AbstractComponentConfig, AbstractJcaComponentConfig, AbstractJcaTableConfig, JcaColumnConfig, JcaInfoConfig, JcaMiniInfoConfig, JcaMiniTableConfig, JcaPropertyConfig, com.ptc.jca.mvc.components.JcaPropertyPanelConfig, JcaTableConfig, JcaTreeConfig, MultiComponentConfig, NestedComponentConfig
public interface ComponentConfig
Base interface for configurations of MVC components.

Implementations optionally support child components via the add/remove component APIs

ComponentConfig instances should typically be created by a ComponentConfigFactory. Supported API: true

Extendable: false

  • Method Details

    • getId

      String getId()
      Returns the id[identifier] for this component.

      Supported API: true
      Returns:
      String

    • setId

      void setId(String id)
      Sets the id[identifier] for this component.

      Supported API: true
      Parameters:
      id -

    • addComponent

      void addComponent(ComponentConfig config)
      Add a ComponentConfig to this Component

      Supported API: true
      Parameters:
      config -

    • addComponents

      void addComponents(List<? extends ComponentConfig> configs)
      Add List of ComponentConfig to this Component

      Supported API: true
      Parameters:
      configs -

    • removeComponent

      void removeComponent(ComponentConfig config)
      Remove an added ComponentConfig from this Component

      Supported API: true
      Parameters:
      config -

    • getComponents

      List<ComponentConfig> getComponents()
      Get the list of ComponentConfig's added to this Component

      Supported API: true
      Returns:
      List

    • getComponentMode

      ComponentMode getComponentMode()
      Get the ComponentMode of the component

      Supported API: true
      Returns:
      ComponentMode

    • setComponentMode

      void setComponentMode(ComponentMode mode)
      Sets the ComponentMode of the component. Defaults to the parent's mode if unspecified.

      Supported API: true
      Parameters:
      mode -

    • getComponentType

      ComponentType getComponentType()
      Get the ComponentType of the component

      Supported API: true
      Returns:
      ComponentType

    • setComponentType

      void setComponentType(ComponentType type)
      Sets the ComponentType of the component.

      Supported API: true
      Parameters:
      type -

    • getTargetObject

      String getTargetObject()
      Returns the targetObject

      Supported API: true
      Returns:
      String

    • setTargetObject

      void setTargetObject(String targetObject)
      Set the TargetObject. The infrastructure treats the objects that are returned by the ConfigDataBuilder as row objects that it works with when it builds the component model and renders the component. By configuring the targetObject property, the developer tells the infrastructure to use an alternate row object that is derived from the backing row object returned by the ConfigDataBuilder. The targetObject property value must correspond to an addressable property of the backing row object.
      The target object will be used in the following places:
      The row object supplied to data utilities
      The object that soft attributes will be extracted from
      The context object for the row checkbox, unless this is overridden by selectionObject

      Supported API: true
      Parameters:
      targetObject -

    • getType

      @Deprecated String getType()
      Deprecated.
      The Main Windchill Type associated with this component. Starting at 11.0 this is replaced by using getTypes()

      Supported API: true
      Returns:
      String The main type for the component

    • getTypes

      default List<TypeIdentifier> getTypes()
      The Windchill Types that are associated with this component, if supported, by default this will return an empty list and in general it is not supported by most config types as of 11.0.

      Supported API: true
      Returns:
      A list of all the types associated with the component if this feature is supported by the config, an empty list otherwise (when supported the list should include the main type as the first entry)

    • setTypes

      default void setTypes(String... types)
      The Windchill Types that are to be associated with this component. These can be either a modeled or soft type. You should specify the external representation of a Windchill Type here. This is not supported by all config types as of 11.0 and will throw an exception if it is called on a config where it is not yet supported by overriding this method

      Supported API: true
      Parameters:
      types - Pass in one or more type names. For components that can contain more than just a single main type. You must pass at least one type do not pass null or an empty array, Additional types are optional. This ability is added at 11.0.

    • setType

      @Deprecated void setType(String mainType)
      Deprecated.
      The Windchill Type (or types) that is to be associated with this component. These can be either a modeled or soft type. You should specify the external representation of a Windchill Type here. Starting at 11.0 this is replaced by using setTypes() with a single type

      Supported API: true
      Parameters:
      mainType - The main type for the component. The main type must be provided as the first parameter. Prior to 11.0 there was only the ability to set this main type. This param should not be null. After 11.0 use setTypes() instead

    • getLabel

      String getLabel()
      Get the localized label for this component.

      Supported API: true
      Returns:
      String

    • setLabel

      void setLabel(String label)
      Set the localized label for this component.

      Supported API: true
      Parameters:
      label -

    • getHelpContext

      String getHelpContext()
      Get the HelpContext for this component

      Supported API: true
      Returns:
      String

    • setHelpContext

      void setHelpContext(String helpContext)
      Sets the help context for this component. No help icon will be displayed if no help context is specified.

      Supported API: true
      Parameters:
      helpContext -

    • getActionModel

      String getActionModel()
      Gets the actionModel name attached to this component

      Supported API: true
      Returns:
      String

    • setActionModel

      void setActionModel(String actionModel)
      Sets the actionModel name attached to this component

      Supported API: true
      Parameters:
      actionModel -