Bug 98432 - [Perspectives] javadoc: IPageLayout needs update for secondary id format
Summary: [Perspectives] javadoc: IPageLayout needs update for secondary id format
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.1 RC2   Edit
Assignee: Nick Edgar CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2005-06-04 22:24 EDT by Jean-Michel Lemieux CLA
Modified: 2005-06-10 12:24 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jean-Michel Lemieux CLA 2005-06-04 22:24:37 EDT
In 3.1 you can now specify "primary:secondary" format in IPageLayout.addView()
but the javadoc in IPageLayout wasn't updated.
Comment 1 Jean-Michel Lemieux CLA 2005-06-06 00:05:27 EDT
This also applies to addPlaceholder which accepts the same id syntax.
Comment 2 Nick Edgar CLA 2005-06-06 10:00:27 EDT
It would be good to clarify.  Jim, these are enhancements to API that existed in
3.0.  See bug 73722 for details.

Comment 3 Jim des Rivieres CLA 2005-06-06 10:07:59 EDT
improving API specs approved for RC2.
Comment 4 Nick Edgar CLA 2005-06-08 21:06:50 EDT
I've added the following to the IPageLayout type javadoc:

 * <p>
 * In some cases, multiple instances of a particular view may need to be added
 * to the same layout.  These are disambiguated using a secondary id.  
 * In layout methods taking a view id, the id can have the compound form: 
 * <strong>primaryId [':' secondaryId]</strong>.
 * If a secondary id is given, the view must allow multiple instances by
 * having specified <code>allowMultiple="true"</code> in its extension.
 * View placeholders may also have a secondary id.
 * </p>
 * <p>
 * Wildcards are permitted in placeholder ids (but not regular view ids).  
 * '*' matches any substring, '?' matches any single character. 
 * Wildcards can be specified for the primary id, the secondary id, or both.  
 * For example, the placeholder "someView:*" will match any occurrence of the view 
 * that has primary id "someView" and that also has some non-null secondary id.
 * Note that this placeholder will not match the view if it has no secondary id,
 * since the compound id in this case is simply "someView".
 * </p>
 
The addView and addPlaceholder methods in IPageLayout, IPlaceholderFolderLayout
and IFolderLayout make reference to this.

Did some other Javadoc cleanup here as well (some wordings were pretty stale).
Comment 5 Nick Edgar CLA 2005-06-10 12:24:29 EDT
Verified in I20050610-0010