| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta |
| http-equiv="Content-Type" |
| content="text/html; charset=ISO-8859-1"> |
| <title>Cheat Sheet tutorial</title> |
| <link |
| rel="stylesheet" |
| type="text/css" |
| href="../sources/formate.css"> |
| </head> |
| <body> |
| <p class="ueberschrift">The pupose of the editor created by this example</p> |
| <p>The editor gives custom content assist while allowing the "auto |
| content model" to continue to be effective. Also, shows how content |
| outline by be customized, and custom navigation hyper link added.</p> |
| <p>An example cheat sheet file can be found in |
| <eclipse_home>/plugins/org.eclipse.jdt_3.1.0/cheatsheets/HelloWorld.xml |
| </p> |
| <p>the custom content assist for attribute values exists for pluginId |
| and class attributes of action elements (inside item elements) - |
| pluginId shows all registered plugin ids - class needs references to |
| org.eclipse.jface.action.IAction and searches for all its implementors |
| to determine which classes are legal inputs for the class attribute</p> |
| <p>The content outline has the titles of the items, the cheatsheet |
| itself and the action classes as nodes.</p> |
| <p class="ueberschrift">SSE principles</p> |
| <p>The structured source editor (SSE) framework is content type based. |
| Therefore if you want to extend the framework with your own file format |
| you have to define your own content type and its model handler. To do |
| this you extend the org.eclipse.core.runtime.contentTypes extension |
| point specifying your content type in the id attribute and using |
| org.eclipse.core.runtime.xml as the base type. The priority should be |
| set to high so you override the default. In the file association element |
| you use your own file extensions or a file name to identify the content |
| type of the file. The usage of the extension point should look like the |
| following:</p> |
| <pre> |
| <extension point="org.eclipse.core.runtime.contentTypes"> |
| <content-type |
| priority="high" |
| name="CS Content Type" |
| id="cssource" |
| base-type="org.eclipse.core.runtime.xml" |
| default-charset="UTF-8"> |
| <describer class="org.eclipse.wst.xml.core.contenttype.ContentDescriberForXML"/> |
| </content-type> |
| <file-association |
| content-type="org.eclipse.wst.cs.ui.cssource" |
| file-names="content.xml"/> |
| </extension> |
| </pre> |
| <p>To use the content type inside of the SSE you have to define a model |
| handler extending the org.eclipse.wst.sse.core.modelHandler extension |
| point. The model handler implementation extends the class |
| org.eclipse.wst.sse.core.modelhandler.AbstractModelHandler and |
| implements the interface |
| org.eclipse.wst.sse.core.modelhandler.IModelHandler. It should set its |
| own id and the associated content type id.</p> |
| <pre> |
| <extension |
| point="org.eclipse.wst.sse.core.modelHandler"> |
| <modelHandler |
| default="false" |
| class="org.eclipse.wst.cs.core.modelhandler.ModelHandlerForCS" |
| associatedContentTypeId="org.eclipse.wst.cs.ui.cssource" |
| id="org.eclipse.wst.sse.core.handler.cs"> |
| </modelHandler> |
| </extension> |
| </pre> |
| |
| <p>This is the starting point for all extensions made to the SSE. Now |
| there are several possibilities where to built in your own extensions.</p> |
| |
| |
| <p class="ueberschrift">Extending the built-in content assist</p> |
| <p>In this example we want to provide a custom content assist processor |
| for attribute values. To extend the content assist of the XML editor |
| from the SSE you just use the |
| org.eclipse.wst.sse.ui.extendedconfiguration extension point and specify |
| your own textviewerconfiguration.</p> |
| <pre> |
| <extension point="org.eclipse.wst.sse.ui.extendedconfiguration"> |
| <textviewerconfiguration |
| <b>class="org.eclipse.wst.cs.ui.StructuredTextViewerConfigurationCS"</b> |
| target="org.eclipse.wst.cs.ui.cssource"> |
| </textviewerconfiguration> |
| <contentoutlineconfiguration |
| class="org.eclipse.wst.xml.ui.views.contentoutline.XMLContentOutlineConfiguration" |
| target="org.eclipse.wst.cs.ui.cssource"> |
| </contentoutlineconfiguration> |
| <propertysheetconfiguration |
| class="org.eclipse.wst.xml.ui.views.properties.XMLPropertySheetConfiguration" |
| target="org.eclipse.wst.cs.ui.cssource"> |
| </propertysheetconfiguration> |
| <spellchecktarget |
| class="org.eclipse.wst.xml.ui.XMLSpellCheckTarget" |
| target="org.eclipse.wst.cs.ui.cssource"> |
| </spellchecktarget> |
| <sourceeditingtexttools |
| class="org.eclipse.wst.xml.ui.extensions.XMLSourceEditingTextTools" |
| target="org.eclipse.wst.cs.ui.cssource"> |
| </sourceeditingtexttools> |
| <characterpairmatcher |
| class="org.eclipse.wst.xml.ui.text.XMLDocumentRegionEdgeMatcher" |
| target="org.eclipse.wst.cs.ui.cssource"> |
| </characterpairmatcher> |
| <preferencepages |
| preferenceids="org.eclipse.wst.sse.ui.preferences/org.eclipse.wst.sse.ui.preferences.cs" |
| target="org.eclipse.wst.cs.ui.cssource"> |
| </preferencepages> |
| </extension> |
| </pre> |
| <p>In the configuration you override the getContentAssistant method from |
| StructuredTextViewerConfigurationXML and provide your own content assist |
| processor for the partition types |
| StructuredTextPartitioner.ST_DEFAULT_PARTITION and |
| StructuredTextPartitionerForXML.ST_DEFAULT_XML.</p> |
| <pre> |
| public IContentAssistant getContentAssistant(ISourceViewer sourceViewer) { |
| IContentAssistant ca = super.getContentAssistant(sourceViewer); |
| if (ca != null && ca instanceof ContentAssistant) { |
| ContentAssistant contentAssistant = (ContentAssistant) ca; |
| IContentAssistProcessor xmlContentAssistProcessor = new CSContentAssistProcessor(getEditorPart()); |
| IContentAssistProcessor noRegionProcessor = new NoRegionContentAssistProcessor(); |
| addContentAssistProcessor(contentAssistant, xmlContentAssistProcessor, StructuredTextPartitioner.ST_DEFAULT_PARTITION); |
| addContentAssistProcessor(contentAssistant, xmlContentAssistProcessor, StructuredTextPartitionerForXML.ST_DEFAULT_XML); |
| addContentAssistProcessor(contentAssistant, noRegionProcessor, StructuredTextPartitioner.ST_UNKNOWN_PARTITION); |
| } |
| return ca; |
| } |
| </pre> |
| <p>The implementation of the content assist processor overrides |
| addAttributeValueProposals from the XMLContentAssistProcessor. The |
| passed ContentAssistRequest stores the match string, the corresponding |
| node and structured document region where the cursor is. To get the |
| attribute name you have to get the last attribute text region in the |
| structured document region.</p> |
| <pre> |
| // Find the attribute region and name for which this position should have a value proposed |
| IStructuredDocumentRegion open = node.getFirstStructuredDocumentRegion(); |
| ITextRegionList openRegions = open.getRegions(); |
| int i = openRegions.indexOf(contentAssistRequest.getRegion()); |
| if (i < 0) |
| return; |
| ITextRegion nameRegion = null; |
| while (i >= 0) { |
| nameRegion = openRegions.get(i--); |
| if (nameRegion.getType() == XMLRegionContext.XML_TAG_ATTRIBUTE_NAME) |
| break; |
| } |
| </pre> |
| <p>To provide your own content assist proposals construct a |
| CustomCompletionProposal and add it to the content assist request.</p> |
| |
| <p class="ueberschrift">Providing your own outline view</p> |
| <p>To change the default outline view you have to provide your own |
| adapter factory provider. To register it with the SSE extend the |
| org.eclipse.wst.sse.ui.adapterFactoryDescription extension point.</p> |
| <pre> |
| <extension point="org.eclipse.wst.sse.ui.adapterFactoryDescription"> |
| <adapterFactoryDescription class="org.eclipse.wst.cs.ui.registry.AdapterFactoryProviderForCS"/> |
| </extension> |
| </pre> |
| <p>The adapter factory provider should add your own adapter factory to |
| the factory registry.</p> |
| |
| </body> |
| </html> |
