Windchill Client Architecture Common Components
Tag describeColumn


Creates a component description for a column. This tag is typically embedded in a parent describe tag, though if var is specified, it can be used on its own.


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

Attributes
NameRequiredRequest-timeTypeDescription
idtruetruejava.lang.StringThe identifier for this column descriptor. This is used to look up default properties for the column. If the parent table supports configurable views, then this id is used to look up the view configurations.
labelfalsetruejava.lang.StringA localized display label for this column. If the label is not specified but the column has a parent descriptor with a main type, then the infrastructure will attempt to use introspection to look up the label. If the table contains more than one type of object, this should be a common ancestor type.
needfalsetruejava.lang.StringAdds a model attribute for this column. The model attribute is used when the column has a logical id that doesn't map to the way the attribute is defined either by introspection or by logical attributes. To specify multiple model attributes, use the EL.
varfalsetruejava.lang.StringThe exported scoped variable to assign the component descriptor to, instead of adding it to a parent descriptor
scopefalsetruejava.lang.StringThe name of the scope to export the var attribute to. The scope can be (case-insensitive): "page", "request", "session", or "application"
modefalsetruejava.lang.StringThe name of one of the modes defined in the com.ptc.core.ui.resoureces.ComponentMode enum. Defaults to the parent descriptor's mode if unspecified
requiredfalsetruebooleanWhether or not each row object must define this attribute. Note that setting this to true does not guarantee a non-null value, it just ensures that the type definition for each row object defines the property
dataUtilityIdfalsetruejava.lang.StringThe id to use for data utility lookup. When unspecified, the descriptor id is used for the lookup.
isInfoPageLinkfalsetruejava.lang.StringOverrides the default behavior of the column/property to add or remove a hyperlink to the info page of the context object this attribute is only applicable for certain columns/properties like name and number. By default the number is a hyperlink to the info page and name is not.
sortablefalsetruebooleanWhen true, the column should be rendered as sortable. Defaults to true.
defaultSortfalsetruebooleanWhen true, the parent table will be sorted by this column when it is rendered for the first time.
ascendingfalsetruebooleanThe direction to sort the columns in.
defaultSecondarySortfalsetruebooleanWhen true, the parent table will be second sorted by this column when it is rendered for the first time. This attribute works in conjunction with defaultSort.
hiddenfalsetruebooleanWhen true, the column will not be shown in the displayed page but can be used in sorting and filtering. This allows custom sorting and filtering options. The default value is false.
targetObjectfalsetruejava.lang.StringThe target object to use for this column when it is processed by the Windchill Client Architecture infrastructure. The semantic of targetObject here is the same as it is for describeTable, with the scope simply changing to this particular column instead of the entire row.
defaultValueDisplayModefalsetruejava.lang.StringThe mode of displaying the default value of an attribute.
selectionListStylefalsetruejava.lang.StringThe style in which the list of choices for an attribute value are to be displayed.
displayLengthInTablesfalsetruejava.lang.StringThe truncation length for values displayed in a table.
displayLengthInInfoPagefalsetruejava.lang.StringThe truncation length for values displayed in an info page.
inputRequiredfalsetruejava.lang.StringIndicates whether a value must be entered for an input field.
htmlIdfalsetruejava.lang.StringThe string to be used as the id of the corresponding HTML element.
stringLengthThreshholdForMultilineInputfalsetruejava.lang.StringThe string length threshhold that determines if a multi-line input field should be used (applicable to string attributes only).
inputFieldTypefalsetruejava.lang.StringSpecify whether the attribute should be displayed as a single-line or multi-line input field (applicable to string attributes only). This directive will override that of the stringLengthThreshholdForMultilineInput preference.
dateInputFieldTypefalsetruejava.lang.StringThis determines if a date input field should be displayed as a DateOnly/DateTime/TimeOnly field.
dateDisplayFormatfalsetruejava.lang.StringThis is the format string used to format a timestamp value.
currencyfalsetruejava.lang.StringThis determines if a numeric value should be displayed in currency format (applicable to numeric fields only).
percentfalsetruejava.lang.StringThis determines if a numeric value should be displayed in percent format (applicable to numeric fields only).
textInputRowsfalsetruejava.lang.Stringrows of text input field (applicable to multi-line input fields only).
textInputColumnsfalsetruejava.lang.Stringcolumns of text input field (applicable to multi-line input fields only).
characterEntryLimitfalsetruejava.lang.Stringmax string entry length for text input field.
distinguishWIPVersionsfalsetruebooleanWhen true, this attribute indcates that glyphs returned by the general status data utility should distinguish between checked-out origianl and working copy. If false (or not-specified), only "working copy" will be displayed
typefalsetruejava.lang.StringSets the type for this column, if the column needs a different main type from its enclosing descriptor

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.