Interface BreadCrumbDelegate
public interface BreadCrumbDelegate
Interface for all BreadCrumbDelegates.
BreadCrumbDelegates manage the BreadCrumbGenerators that produce the JSONObject bread crumbs used to display the bread crumb string at the top of Windchill pages. Different delegates may be used for different pages. All delegates must be registered in the wt.property "com.ptc.windchill.enterprise.navigation.breadcrumb.BreadCrumbDelegate."
The BreadCrumbDelegateFactory finds the correct delegate for a given page by calling the canHandle() method of delegates in priority order.
Delegates contain an AbstractBreadCrumbGenerator inner class. The getGenerator() method should return a new instance of the generator class each time it is called. However, the factory will generate only one instance of each delegate class so delegates may not use class instance variables or be stateful in any way.
See the package javadoc for more information.
Supported API: true
Extendable: false
BreadCrumbDelegates manage the BreadCrumbGenerators that produce the JSONObject bread crumbs used to display the bread crumb string at the top of Windchill pages. Different delegates may be used for different pages. All delegates must be registered in the wt.property "com.ptc.windchill.enterprise.navigation.breadcrumb.BreadCrumbDelegate."
The BreadCrumbDelegateFactory finds the correct delegate for a given page by calling the canHandle() method of delegates in priority order.
Delegates contain an AbstractBreadCrumbGenerator inner class. The getGenerator() method should return a new instance of the generator class each time it is called. However, the factory will generate only one instance of each delegate class so delegates may not use class instance variables or be stateful in any way.
See the package javadoc for more information.
Supported API: true
Extendable: false
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionbooleancanHandle(Persistable contextObject, WTContainer container, String url) Returns true if the generator associated with this delegate can be used to generate the bread crumbs for the page represented by the given URL.getGenerator(Persistable contextObject, WTContainer container, String url) Returns an instance of the generator associated with this delegate
-
Method Details
-
canHandle
Returns true if the generator associated with this delegate can be used to generate the bread crumbs for the page represented by the given URL. Returns false otherwise.- Parameters:
contextObject- The object represented by the "oid" parameter on the URL, if any. May be null.container- The object represented by the "ContainerOid" parameter on the URL, if any. May be null.url- The URL for the current page. For example: ptc1/tcomp/infoPage?oid=OR :wt.pdmlink.PDMLinkProduct:42485invalid input: '&u8'=1- Throws:
WTException-
Supported API: true
-
getGenerator
AbstractBreadCrumbGenerator getGenerator(Persistable contextObject, WTContainer container, String url) throws WTException Returns an instance of the generator associated with this delegate- Parameters:
contextObject- The object represented by the "oid" parameter on the URL, if any. May be null.container- The object represented by the "ContainerOid" parameter on the URL, if any. May be null.url- The URL for the current page. For example: ptc1/tcomp /infoPage?oid=OR:wt.pdmlink.PDMLinkProduct:42485invalid input: '&u8'=1- Throws:
WTException-
Supported API: true
-