Parameter
|
Default Value
|
Possible values
|
Req?
|
Description
|
id
|
-
|
Any value
|
Yes
|
Used to distinguish between the multiple Type-Picker usages in a page. The id value should not contain "." (dot).
|
label
|
-
|
Any value
|
No
|
Used as the Picker label
|
mode
|
SEARCH
|
-
|
No
|
Defines in which mode the Type Picker is going to be used and it should be one of the value defined in com.ptc.core.ui.resources.ComponentMode
|
field
|
-
|
-
|
No
|
Target Element is the one in which the selected elements attributes will be populated. It should be a subclass of com.ptc.core.components.rendering.AbstractGuiComponent Currently support TextBox and ComboBox
|
renderContext
|
-
|
-
|
No
|
Object should be an instance of com.ptc.core.components.rendering.RenderingContext. If not supplied the component will create one for the user.
|
objectType
|
typepicker
|
-
|
No
|
This is the object type in which the picker action is specified in *actions.xml .
<Windchill>\codebase\config\actions\EnterpriseUI-actions.xml
|
actionName
|
typePicker
|
-
|
No
|
This is the action name that is specified in *actions.xml for the picker action
|
Parameter
|
Default Value
|
Possible values
|
Req?
|
Description
|
adminDomainRef
|
-
|
No
|
String representation of the administrative domain reference (wt.admin.AdminDomainRef). Used to check access control rights.
|
|
containerRef
|
-
|
No
|
String representation of the container reference (wt.inf.container.WTContainerRef) and is used to populate types specified for this container.
If adminDomainRef is provided, containerRef is calculated from that even if user has supplied it.
If adminDomainRef is NOT provided, component uses the default AdminDomain for the supplied containerRef or if containerRef is not provided, component uses default WTContainer (Exchange container).
|
|
lifeCycleState
|
-
|
No
|
String representation of State (wt.lifecycle.State) and is used while checking access control rights.
|
|
seedType
|
-
|
-
|
No
|
Accepts valid logical or external representation of Windchill Type Identifiers. Multiple values supported and it’s required for mode = CREATE/EDIT/VIEW
|
filterType
|
-
|
-
|
No
|
Accepts valid logical or external representation of Windchill Type Identifiers. Multiple values supported.
The type and its descendants are filtered out from the picker element
|
defaultType
|
-
|
-
|
No
|
Accepts valid logical or external representation of Windchill Type Identifiers. For single select, it should be only one value. Multiple values are supported and it’s required for mode = EDIT/VIEW. It can support blank, "Select a Type" etc values also.
|
appOption
|
-
|
-
|
No
|
Localized Display name and value separated by a "$" delimiter and multiple values are supported.
|
format
|
dropdown
|
-
|
No
|
It should be one of the enum constant value defined in com.ptc.windchill.enterprise.picker.type.server.TypePickerFormat. The possible values are dropdown, table, tree
|
select
|
single
|
-
|
No
|
Possible values are single and multi.
|
type
|
BOTH
|
-
|
No
|
It should be one of the enum constant value defined in com.ptc.windchill.enterprise.picker.type.server.TypePickerTypes. Possible values are ROOT_TYPES (only seedTypes will be displayed), SOFT_TYPES (only SOFT Types will be displayed), BOTH (MODELED & SOFT Types will be displayed)
|
displayHierarchy
|
false
|
false/true
|
No
|
Accepts String representation of Boolean value. This is valid only for dropdown format for which it presents picker elements in hierarchy.
|
showInstantiable
|
false
|
false/true
|
No
|
Accepts String representation of Boolean value. If true - only instantiables will be displayed and for false both instantiables and non-instantiables will be displayed
|
showRoot
|
true
|
false/true
|
No
|
Accepts String representation of Boolean value. If true shows the seedTypes as I level elements.
|
componentId
|
Foundation.allSearch
|
-
|
No
|
componentId is defined as 'APP_ID+.+COMPONENT_NAME'.
Valid APP_IDs are ProjectLink, Foundation, or PDMLink. This is used for mode = "SEARCH" to find the I level types from <Windchill>\codebase\com\ptc\windchill\enterprise\search\server\SearchableTypes.properties. Passing null will default to the Default
|
pickerCallBack
|
typePickerPopulateTargetElement
|
-
|
No
|
A javaScript function that will be invoked to populate the selected element attributes in the target element. This is not applicable for dropdown.
|
pickedDataFetcher
|
netmarkets/jsp/typepicker/typePicker_dataFetcher.jsp
|
-
|
No
|
A jsp file which is invoked in the AJAX call to fetch attributes of the picked elements. The file should be located in the <Windchill>/codebase and relative path is the value to be provided. It’s not applicable for dropdown.
|
filterByInterface
|
-
|
Valid Windchill Interface
|
No
|
String representation of valid windchill Interface. Its Single valued parameter. For example, filterByInterface = “wt.index.Indexable”
If filterByInterface param configured then only subtypes of seedType that implement the interface should be displayed in the type hierarchy. Here, Type picker will show only subtypes of seedType which implements Indexable interface.
Seed type is always selectable even if non-instantiable when this parameter is configured.
When fliterByInterface configured along with ShowInstantiable=true then only instantiable type which implements interface will be available in type picker.
|
additionalTypes
|
-
|
Valid Windchill Abstract class
|
No
|
String representation of valid Windchill Abstract Classes. Its Multi valued parameter. For example, additionalTypes= “wt.meeting.Meeting, wt.org.WTPrincipal”
All abstract classes specified by this parameter will be present in type picker as long as they are subclasses of the seedType and implement the interface specified by the filterByInterface parameter.
This parameter is dependent on filterByParameter. Type picker framework respects this parameter only when filterByInterface is configured.
|
showInternalNameAsTooltip
|
false
|
false/true
|
No
|
Accepts String representation of Boolean value.
If true then shows tooltip as internal name of type, otherwise shows display name of type
|
Property
|
Description
|
Example
|
wt.typepickerexcludedelimiter
|
wt.typepickerexcludedelimiter=<delimiter string>
This defines the delimiter to be used for ‘wt.typepickerexclude’ property and the default value is ‘,’
|
wt.typepickerexcludedelimiter=;
|
wt.typepickerexclude/<mode>/<root type>
|
wt.typepickerexclude/<mode>/<root type>=<delimited list of external string representation of type identifier>
• ‘mode’ should be one of the value defined in com.ptc.core.ui.resources.ComponentMode
• If no ‘mode’ identifier is specified, then it’s assumed that the property is applicable to all mode.
• Multiple values are to be separated by wt.typepickerexcludedelimiter property
• Excludes the listed types and all their modeled and soft subtypes from the Type Picker if the root type matches the provided seedType.
|
wt.typepickerexclude/CREATE/wt.doc.WTDocument=WCTYPE|wt.doc.WTDocument|org.r_and_d.Agenda
wt.typepickerexclude/wt.doc.WTDocument=WCTYPE|wt.doc.WTDocument|org.r_and_d. Meeting
|
wt.typepickerexclude/<mode>/<container type>
|
wt.typepickerexclude/<mode>/<container type>=<delimited list of external string representation of type identifier>
• ‘mode’ should be one of the value defined in com.ptc.core.ui.resources.ComponentMode
• If no ‘mode’ identifier is specified, then it’s assumed that the property is applicable to all mode.
• Multiple values are to be separated by wt.typepickerexcludedelimiter property
• Excludes the listed types and all their modeled and soft subtypes from the Type Picker if the container type matches the provided containerRef.
|
wt.typepickerexclude/CREATE/wt.pdmlink.PDMLinkProduct =WCTYPE|wt.doc.WTDocument|org.r_and_d.Agenda
wt.typepickerexclude/wt.pdmlink.PDMLinkProduct =WCTYPE|wt.doc.WTDocument|org.r_and_d.General
|