Bug 38247 - [Viewers] [Javadoc] Incomplete javadoc for DialogCellEditor
Summary: [Viewers] [Javadoc] Incomplete javadoc for DialogCellEditor
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 2.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.0 M9   Edit
Assignee: Nick Edgar CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2003-05-29 17:20 EDT by Genady Beryozkin CLA
Modified: 2004-05-07 11:41 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Genady Beryozkin CLA 2003-05-29 17:20:26 EDT
The javadoc for #openDialogBox() does not say how to indicate that 
the dialog box was canceled. 
The de-facto behaviour is that if null is returned, it is considered 
as "cancel".
Comment 1 Debbie Wilson CLA 2003-06-02 09:46:35 EDT
I assume you mean the method declaration in class DialogCellEditor?
Comment 2 Genady Beryozkin CLA 2003-06-02 12:43:17 EDT
yes
Comment 3 Nick Edgar CLA 2004-05-07 11:41:47 EDT
Clarified the spec for openDialog as follows:
/**
 * Opens a dialog box under the given parent control and returns the
 * dialog's value when it closes, or <code>null</code> if the dialog
 * was cancelled or no selection was made in the dialog.
 * <p>
 * This framework method must be implemented by concrete subclasses.
 * It is called when the user has pressed the button and the dialog
 * box must pop up.
 * </p>
 *
 * @param cellEditorWindow the parent control cell editor's window
 *   so that a subclass can adjust the dialog box accordingly
 * @return the selected value, or <code>null</code> if the dialog was 
 *   cancelled or no selection was made in the dialog
 */

I'm viewing this as a spec clarification, not a breaking API change, since 
callers would have already had to handle null.