Editor Configuration

Identifier:
org.eclipse.wst.sse.ui.editorConfiguration

Since:
1.0

Description:
The SSE StructuredTextEditor is intended to be as flexible as possible. Much of its design centers around the notion of defining and redefining its behavior and appearance based on the content type of its input. This extension point allows clients to provide an editor configuration to the StructuredTextEditor without having to subclass the editor.

Configuration Markup:

<!ELEMENT extension (sourceViewerConfiguration* , contentOutlineConfiguration* , propertySheetConfiguration* , documentationTextHover* , doubleClickStrategy* , provisionalConfiguration* , provisionalDefinition*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT sourceViewerConfiguration EMPTY>

<!ATTLIST sourceViewerConfiguration

target CDATA #REQUIRED

class  CDATA #REQUIRED>

Defines the source viewer configuration, affecting syntax highlighting, content assist, hover help, and more in the current editor.



<!ELEMENT contentOutlineConfiguration EMPTY>

<!ATTLIST contentOutlineConfiguration

target CDATA #REQUIRED

class  CDATA #REQUIRED>

Defines how the current editor's input maps to elements with in a Tree control, as well as selection filtering, toolbar and menu contributions, etc in the Outline view.



<!ELEMENT propertySheetConfiguration EMPTY>

<!ATTLIST propertySheetConfiguration

target CDATA #REQUIRED

class  CDATA #REQUIRED>

Defines how the current editor's input maps to properties in a Table control, as well as toolbar contributions, etc in the Properties view.



<!ELEMENT documentationTextHover EMPTY>

<!ATTLIST documentationTextHover

target CDATA #REQUIRED

class  CDATA #REQUIRED>

Defines the text hover processor to use to display documentation information in a text hover. Note, in the event more than one documentation text hover is contributed for the same target partition type, the first one loaded will be the one used and all other contributions will be ignored.
Since 3.0



<!ELEMENT doubleClickStrategy EMPTY>

<!ATTLIST doubleClickStrategy

target CDATA #REQUIRED

class  CDATA #REQUIRED>

Defines the doubleclick strategy to use when the user performs a mouse doubleclick. Note, in the event more than one doubleclick strategy is contributed for the same target partition type, the first one loaded will be the one used and all other contributions will be ignored.
Since 3.0



<!ELEMENT provisionalConfiguration EMPTY>

<!ATTLIST provisionalConfiguration

target CDATA #REQUIRED

type   CDATA #REQUIRED

class  CDATA #REQUIRED>

Declares a class fulfilling the requirements of a type to be used for the given target(s). Note: this is not API and is only used for provisional configuration types.



<!ELEMENT provisionalDefinition EMPTY>

<!ATTLIST provisionalDefinition

type   CDATA #REQUIRED

value  CDATA #IMPLIED

target CDATA #REQUIRED>

Defines a value for a type to be used for the given target(s). Note: this is not API and is only used for provisional configuration types.



Examples:

   <extension 
         point="org.eclipse.wst.sse.ui.editorConfiguration">
      <!-- associating a source viewer configuration to an input's content type-->
      <sourceViewerConfiguration
            class="org.eclipse.wst.html.ui.StructuredTextViewerConfigurationHTML"
            target="org.eclipse.wst.html.core.htmlsource"/>
      <!-- associating an outline configuration to an input's content type -->
      <contentOutlineConfiguration
           class="org.eclipse.wst.sse.xml.ui.views.contentoutline.XMLContentOutlineConfiguration"
            target="org.eclipse.core.runtime.xml"/>
      <!-- associating a property sheet configuration to multiple content types -->
      <propertySheetConfiguration
            class="org.eclipse.wst.xml.ui.views.properties.XMLPropertySheetConfiguration"
            target="org.eclipse.wst.sse.contenttype.xml, org.eclipse.wst.html.core.htmlsource, org.eclipse.jst.jsp.core.jspsource"/>
   </extension>


Copyright (c) 2005, 2007 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html