Sticky Lines Providers

Identifier:
org.eclipse.ui.editors.stickyLinesProviders

Since:
3.20

Description:
This extension point is used to register sticky lines providers for editors.

Configuration Markup:

<!ELEMENT extension (stickyLinesProvider+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT stickyLinesProvider (enabledWhen?)>

<!ATTLIST stickyLinesProvider

id    CDATA #REQUIRED

class CDATA #REQUIRED>

A sticky lines provider.



<!ELEMENT enabledWhen (not | or | and | instanceof | test | systemTest | equals | count | with | resolve | adapt | iterate | reference)?>

A core Expression that controls the enabled of the given sticky lines provider



Examples:
The following is an example of a sticky line provider definition:

   <extension
         point="org.eclipse.ui.editors.stickyLinesProviders">
      <stickyLinesProvider
            class="org.eclipse.ui.internal.texteditor.stickyscroll.DefaultStickyLinesProvider"
            id="org.eclipse.ui.editors.stickyLinesProviderExample"
            label="Example sticky lines provider registration">
         <enabledWhen>
            <and>
               <with variable="editor">
                  <instanceof value="org.example.MyEditorWithStickyScrolling"/>
               </with>
            </and>
         </enabledWhen>
      </stickyLinesProvider>
   </extension>

API Information:
See the org.eclipse.ui.texteditor.stickyscroll.IStickyLinesProvider interface and the org.eclipse.ui.editors.stickyLinesProviders extension point. As default implementation for the IStickyLine, see org.eclipse.ui.texteditor.stickyscroll.StickyLine.


Copyright (c) 2024 SAP SE.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0 Contributors: SAP SE - initial API and implementation