Bug 312381

Description Ankit Goel 2010-05-11 04:42:41 EDT

Build Identifier: I20090611-1540

I tried embedding org.eclipse.wst.sse.ui.internal.StructuredTextViewer in a dialog for editing XML code. But in this case the Smart Insert Close Element functionality (automatic insertion of ending tags) does not work as expected.

Here goes the problem:

CASE 1: If my dialog is launched with a WTP XML editor open in the background than the ending tags are inserted automatically.

CASE 2: If the dialog is launched alone (with no WTP XML editor in background) ending tags would not be inserted.

I did little debugging on this and realized that org.eclipse.wst.xml.ui.internal.autoedit.StructuredAutoEditStrategyXML class causes this problem. Whenever a key is pressed the method StructuredAutoEditStrategyXML >> customizeDocumentCommand(IDocument, DocumentCommand) is called. This is responsible for inserting the ending tags etc. But before doing the functionality it checks which editor is active and exits without doing anything if appropriate editor is not present.

Hence following happens:

Case 1: (Described above) It finds the WTP XML editor in the background and hence automatically inserts ending tags in the dialog I have created.

Case 2: (Described above) Does not find a WTP XML editor in the background and hence it does not insert the ending tags.

Why the smart insert close element functionality needs to be dependent on a active text editor ? Seems something is wrong in there!!!

Reproducible: Always

Steps to Reproduce:
1. Create a Dialog of your own (by extending TrayDialog class) for editing XML code. This dialog should contain a StructuredTextViewer - need to override the method protected Control createDialogArea(Composite parent). (Will try and attach the java code as a seperate file that does this job)

	protected Control createDialogArea(Composite parent) {
		Composite composite = new Composite(parent, SWT.NONE);
		composite.setLayout(new RowLayout(SWT.VERTICAL));
		IDocument document = getDocument();
		createXMLSourceViewer(composite, document);
		return composite;
	}

	private void createXMLSourceViewer(Composite composite, IDocument document) {
		RowData rowData = new RowData(800, 300);
		StructuredTextViewer structuredViewer = new StructuredTextViewer(composite, null, null,
				true, SWT.NONE);
		structuredViewer.getControl().setLayoutData(rowData);
		StructuredTextViewerConfigurationXML sourceViewerConfiguration = new StructuredTextViewerConfigurationXML();
		structuredViewer.configure(sourceViewerConfiguration);
		structuredViewer.setDocument(document);
	}

	private IDocument getDocument() {
		IDocument document = null;
		IStructuredModel scratchModel = null;
		try {
			scratchModel = StructuredModelManager.getModelManager()
					.getModelForEdit(ContentTypeIdForXML.ContentTypeID_XML,
							new FileInputStream(new File("C:/trialtext.xml")),
							null);
		} catch (IOException e) {
			e.printStackTrace();
		}
		document = scratchModel.getStructuredDocument();
		return document;
	}

Make sure a file C:/trialtext.xml exists.

2. Do relevant coding for launching this dialog from the main menu (or any other point convenient to you).
3. Open a XML file in WTP XML editor.
4. Launch the created dialog (the WTP XML editor opened in Step 3 remains in the background).
5. Type the following:
 <abc>
You will observe that the closing tag </abc> gets inserted automatically.
6. Now close this dialog and the WTP XML editor as well.
7. Launch the dialog again (no other editor should be opened in the background).
8. Type the following:
 <abc>
You will observe that nothing happens - the closing tag </abc> is not inserted automatically.

To get hold of the problem put a break point at the following method:
org.eclipse.wst.xml.ui.internal.autoedit.StructuredAutoEditStrategyXML >> customizeDocumentCommand(IDocument, DocumentCommand)
Every time you press a key on the dialog the debugger stops here.
In step 5 it finds a WTP XML editor and hence inserts the ending tags.
In step 8 no editor is found. It exist without inserting the ending tags.