Windchill Client Architecture Common Components


Standard Syntax:
     <%@ taglib prefix="components" uri="http://www.ptc.com/windchill/taglib/components" %>

XML Syntax:
     <anyxmlelement xmlns:components="http://www.ptc.com/windchill/taglib/components" />

Windchill Client Architecture components library

Tag Library Information
Display NameWindchill Client Architecture Common Components
Version1.1
Short Namecomponents
URIhttp://www.ptc.com/windchill/taglib/components
 

Tag Summary
describeTableDescribes a table component that can be plugged in to Windchill Client Architecture get and render tags.
describeTableTreeDescribes a tree component that can be plugged in to Windchill Client Architecture get and render tags.
describeColumnCreates 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.
setComponentPropertyHelper tag that sets properties on the component descriptor managed by a parent describe tag. Alternatively, the component descriptor to configure can be specified using the target attribute.
getModelCreates a component model based on the supplied component descriptor and query parameters. The resulting model is assigned to a scoped variable specified by the var attribute.
addServiceArgumentHelper tag that adds method arguments to ServiceModelCommand-based method calls. The tag can either be nested within a GetModel tag, or alternatively the command instance can be passed explicitly to the tag
renderTableRenders a netmarkets table. If the var attribute is set, then the tag will set page-scoped attribute with an NmHTMLTable based on the supplied ComponentModel. If the var tag is empty, then the NmHTMLTable is created and drawn. The tag also supports drawing a pre-built NmHTMLTable by specifying the table attribute.
renderTableTreeRenders a netmarkets tree. If the var attribute is set, then the tag will set a page-scoped attribute with an NmHTMLTableTree based on the supplied ComponentModel. If the var tag is empty, then the NmHTMLTableTree is created and drawn. The tag also supports drawing a pre-built NmHTMLTableTree by specifying the tree attribute.
getNonSelectablesTo remove the checkbox on certain table rows, use this child tag to set a class and method that will determine the list of NmOids for the special non-selectable rows. The child tag is specified on the renderTable*Tag.
renderTableInPaneRenders a table similar to the renderTable tag, but without the excess left margin space.
renderTwoPanesRenders a two-pane display. Calls specified JSPs to render the contents of each pane.
renderSimpleTreeRenders a simple tree (like a directory hierarchy). If the var attribute is set, then the tag will set a page-scoped attribute with an NmHTMLTableTree based on the supplied ComponentModel. If the var tag is empty, then the NmHTMLTableTree is created and drawn. The tag also supports drawing a pre-built NmHTMLTableTree by specifying the tree attribute.
describeInfoPageCreates a component descriptor for an info page that can be plugged in to data acquisition and rendering engines
describeStatusGlyphSubtag of that adds a component descriptor to the parent descriptor. If var is specified, then the component descriptor is added to the page instead of to a parent.
describePropertyPanelCreates a component descriptor for an info page that can be plugged in to data acquisition and rendering engines
addPropertyAdd a property to renderPropertyPanel tag
addPropertyPanelAdd a property panel to renderPropertyPanel tag
addPlaceHolderAdd a place holder in a property panel to be filled in dynamically via javascript
addSeparatorAdd a separator to renderPropertyPanel tag
addHeaderAdd header text within a renderPropertyPanel tag
addPropertyPanelDescriptorAdd a descriptor to describeInfoPage tag
renderPropertyPanelRenders a property panel with multiple models
renderPropertyLabelRenders a property label (e.g. for name "Name:")
renderPropertyValueRenders a property value (e.g. for name "GOLF_CART")
renderAccessibilityLinkRenders the hidden link for the 508 support
renderThirdLevelNavrenders the 3rd level navigation
renderActionsMenurenders the link for an object's "Actions" menu (used on the info page and in tables)
wizardStepNo Description
wizardNo Description
searchBartype based lookup for a jsp fragment to be included in the page
headerThis prints out the standard header including the logo, global links (clipboard, help etc), and the tabs and sub tabs. This tag also invokes the contextBar and searchBar tages This tag is generally included by using begin.jspf rather than invoked on its own.
footerThis prints out the standard footer. This tag is generally included by using footer.jspf rather than invoked on its own.
includeFormComponentIncludes a jsp file containing one or more input fields in the curernt page and writes a hidden input field to the page specifying the processor class for the input fields. See the javadoc for the class IncludeFormComponent for more information.
excludeColumnThis tag may be included as a subtag in a describeColumn tag for a multi-attribute column descriptor like "ALL_SOFT_ATTRIBUTES". It will exclude the specified member attribute from the table. See the javadoc for the class ExcludeColumnTag for more information.
excludePropertyThis tag may be included as a subtag in a describeProperty tag for a multi-attribute property descriptor like "ALL_SOFT_ATTRIBUTES". It will exclude the specified member attribute from the table or panel. See the javadoc for the class ExcludeColumnTag for more information.
actionRenders an action that is defined in actions.xml
participantPickerParticipant Picker Common component.
getIeModelGetModel tag for InfoEngine. Uses the com.ptc.core.components.adapter.GetModelWebjectDelegate to retrieve a ComponentModel for an input ComponentDescriptor. This tag supports nested tags, refer to the documentation of GetModelWebjectDelegate for supported params.
initializeItemInitializes an object being created or edited in a jsp wizard
configureTypePickerIncludes and configures the type picker used in item creation wizards. Accepts these optional "pickerParam" subtags: "seedType", "defaultType", "filterType", "adminDomainRefString", and "displayHierarchy." If these are not included, default values will be used. See the javadoc for the ConfigureTypePicker class for more information.
propagateComponentInserts a Propagate Component checkbox in the current page.
describeAttributesTableCreates a component descriptor for an attributes table. This is a 2-column table of an object's attributes. Attribute labels are in the left column and attribute values in the right column.
describePropertySubtag of and
suggestParmServes as a child tag to the SuggestTextBoxTag. Allows developers to add parameters that will be sent to their implementation of Suggestable
setWizardNavObserverRegisters Observer tasks for wizard step navigation and specifies the function to call upon upon registering an observed event with the listen.
getCurrentViewGets the current table view id and assigns it to a page-scoped variable
setSavedSearchViewSets the saved search view for a given table, and allows the display of the saved search view instead of the user's active view.
tabToHighlightused to set which tab should be highlighted this tag adds request params that will tell the navigation which action in the navigation action model is the tab to highlight
setPageTitleThis tag provides an interface for setting a browser window's page title from a JSP file. The tag takes its three attributes and set them in the HttpServletRequest. This data is later used by the DefaultNavigationDelegate to set the browser window's page title.
includeConfirmDialogThis tag provides all the framework for a Dojo based JS dialog. The implementer can declare this tag and show the dialog by using the syntax dialogId.show( ); Each dialog included in a page should have a unique ID, however the tag may be included multiple times.
 

Function Summary
java.lang.StringgetLocalizedMessage( java.lang.String, java.lang.String, java.lang.Object[] )No Description
 


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