Summary: | API naming issues: ensure proper naming of public API | ||||||||
---|---|---|---|---|---|---|---|---|---|
Product: | [Modeling] GMF-Runtime | Reporter: | Steven R. Shaw <steveshaw> | ||||||
Component: | General | Assignee: | Cherie Revells <crevells> | ||||||
Status: | RESOLVED FIXED | QA Contact: | |||||||
Severity: | enhancement | ||||||||
Priority: | P1 | CC: | mhanner, min123 | ||||||
Version: | 1.0 | Keywords: | api, contributed | ||||||
Target Milestone: | 1.0 | ||||||||
Hardware: | PC | ||||||||
OS: | Windows XP | ||||||||
Whiteboard: | |||||||||
Attachments: |
|
Description
Steven R. Shaw
2005-10-19 16:52:36 EDT
- Remove Messages.java / Images.java – use ResourceManager instead. - Remove DiagramEditPart.getScrollableControl() – doesn’t seem to be used anywhere. - Move ConnectorUnmoveableEditPolicy, ShapeUnmoveableEditPolicy out of diagram.ui. - Remove AddUMLActionBarTool. - Rename the following: Presentation*Provider Diagram*Provider PresentationAction DiagramAction AttachedShapeAction AttachShapeAction ShapeResizableEditPolicy ResizableShapeEditPolicy ShapeLabelResizableEditPolicy ResizableShapeLabelEditPolicy ShapeRotatableEditPolicy RotatableShapeEditPolicy *NonResizableEditPolicy NonResizable*EditPolicy ListItemCompartmentEditPart ListItemEditPart More potential renames: CreateOrSelectElementCommand -- PromptForElementCommand GetConnectorTypeAndEndCommand -- PromptForConnectionAndEndCommand PopupMenuCommand -- PromptCommand Need to be sure to propogate these API changes into the SDK html as well... Discussion on renaming of Gate*... Suggested Names: GateFigure BorderItemFigure GateFigure.GateLocator BorderItemLocator GatedFigure BorderedFigure GatedPaneFigure BorderedPane or BorderedFigurePane? (This is a pane that contains a bordered figure.) GateEditPart BorderItemEditPart GatedShapeEditPart BorderedShapeEditPart GatedCompartmentEditPart BorderedCompartmentEditPart GateNonResizableEditPolicy This extends NonResizableEditPolicyEx, is used for the PRIMARY_DRAG_ROLE on gates themselves, and says "Edit policy to restrict gate movement along border of Gated item." How about FixedBorderItemEditPolicy? GatedShapeCompartmentDragDropEditPolicy BorderedShapeCompartmentDragDropEditPolicy or BorderedDragDropEditPolicy to be shorter? Comments: - GatedShapeCompartmentDragDropEditPolicy, GatedCompartmentEditPart – Not needed, can be deleted. - Re; BorderedPane vs BorderedFigurePane: Depends on which one is more consistent with other namings... - The FixedDistanceGatedXXXX stuff could also be renamed/removed. It was intended as an intermediate fix that seemed to stay around ;-) This class is internal so I will leave this for later. - The new names seem very reasonable. The only suggestion I would have would be for the GateNonResizableEditPolicy. I would suggest not using the term 'Fixed' since the border items are not fixed but 'restricted'. Updated Suggested Names: GateFigure BorderItemFigure GateFigure.GateLocator BorderItemLocator GatedFigure BorderedFigure GatedPaneFigure BorderedPane GateEditPart BorderItemEditPart GatedShapeEditPart BorderedShapeEditPart GatedCompartmentEditPart To be deleted GateNonResizableEditPolicy BorderItemSelectionEditPolicy GatedShapeCompartmentDragDropEditPolicy To be deleted I got clarification over what some of these gate figures are used for. I have made the following changes: GatedFigure BorderItemContainerFigure GatedPaneFigure BorderedFigure - PresentationPrintGlobalActionHandlerProvider should be public and renamed to DiagramPrintGlobalActionHandlerProvider. - PresentationRenderedPrintGlobalActionHandler should have a corresponding Provider class. Can probably eliminate the word "Rendered" from these... Created attachment 29196 [details]
Public API renames about to take place.
Created attachment 29864 [details]
Final document describing API changes
API changes
This has been completed; howeer, the deprecated API is still available. Purpose: Removing deprecated classes after renaming activity . Activities: Bugzilla#113157 gmf_head cmahoney 051125 Removing deprecated classes Code Reviewed by: Steve How tested: - Verified there were no compile errrors. Launching org.eclipse.gmf.tests.runtime.diagram.ui OK, Runs: 69, Fails: 0, Errors: 0, org.eclipse.gmf.tests.runtime.diagram.ui, Time: 94.266 Launching org.eclipse.gmf.tests.runtime.draw2d.ui OK, Runs: 35, Fails: 0, Errors: 0, org.eclipse.gmf.tests.runtime.draw2d.ui, Time: 0.312 Launching org.eclipse.gmf.tests.runtime.draw2d.ui.render OK, Runs: 3, Fails: 0, Errors: 0, org.eclipse.gmf.tests.runtime.draw2d.ui.render, Time: 5.344 [target cleanup] 1.0 M3 was the original target milestone for this bug [GMF Restructure] Bug 319140 : product GMF and component Runtime Diagram was the original product and component for this bug |