Windchill Client Architecture Common Components
Tag describeTable


Describes a table component that can be plugged in to Windchill Client Architecture get and render tags.


Tag Information
Tag Classcom.ptc.core.components.tags.components.DescribeTableTag
TagExtraInfo ClassNone
Body Contentscriptless
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
idtruetruejava.lang.StringThe identifier for this table descriptor. If this table supports configurable views, then this id may be used to look up the view configurations, unless it is overridden by the configurableTableId attribute.
vartruetruejava.lang.StringName of the exported scoped variable for the table descriptor. The type of the variable is com.ptc.core.components.descriptor.ComponentDescriptor.
scopefalsetruejava.lang.StringThe name of the scope to export the var attribute to. The scope can be (case-insensitive): "page", "request", "session", or "application"
typefalsetruejava.lang.StringName of the main type of object displayed in this table. This can be either a modeled or soft type. When specified, the infrastructure will use the type to look up labels and other default values when it can't find them otherwise. If the table contains more than one type of object, this should be a common ancestor type.
labelfalsetruejava.lang.StringThe localized label for this component.
modefalsetruejava.lang.StringThe name of one of the modes defined in the com.ptc.core.ui.resoureces.ComponentMode enum. VIEW is the default mode if not specified.
componentTypefalsetruejava.lang.StringThe name of one of the component types defined in the com.ptc.core.ui.resoureces.ComponentType enum. TABLE is the default if not specified.
configurablefalsetruebooleanWhether or not this table supports configurable views. Defaults to false.
configurableTableIdfalsetruejava.lang.StringThe id to use to look up configurable views. If unspecified, then defaults to the table id. Only used if configurable is set to true
singleViewOnlyfalsetruebooleanWhen this property is true, and the table is configurable, then this property will change the table rendering so that 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.
toolbarNamefalsetruejava.lang.StringThe name of the action model to use for toolbar actions.
menubarNamefalsetruejava.lang.StringThe name of the action model to use for menubar actions.
helpContextfalsetruejava.lang.StringThe help context for this table. No help icon will be displayed if no help context is specified.
targetObjectfalsetruejava.lang.StringAllows the developer to change how Windchill Client Architecture processes the results of a get call. Typically the infrastructure treats the objects that are returned by the service API or task specified in the get tag as the "row" objects that it works with when it builds the component model and renders the table. 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 underlying api. 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
selectionObjectfalsetruejava.lang.StringAllows the developer to change the context object used in the row checkbox. Must correspond to a property name of the backing row object. Note that unlike targetObject, selectionObject does not change the object used for server-side processing in data utilities.
summaryfalsetruejava.lang.StringA localized summary of the information in this table which is used for accessibility compliance.
disableActionfalsetruejava.lang.StringFlag to indicate enable or disable collapse/expand action.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.