schema.spyPart.exsd Maven / Gradle / Ivy
The newest version!
<p>A spy is a specific window used to help the debug of your application. </p>
<p>It can be opened with a key board short cut, and the first time, all the spies will appear in the same window (called 'E4 spies'). This window reminds to the developper all the available spies in a main toolbar.</p>
<br/>To add a spy, just describe the part, and the shortcut.
This extension point is then managed by this plugin to add automatically short cut, handlers, command and icon in the application model.
The name of the spy (displayed in the tab)
The pojo class of the spy part. There is no contraints of ihneritance for this part. There must be a @PostConstruct method to create the contents :
<br/>
<p>
@PostConstruct
public void mySpyContent(Composite parent)
{
// Create your contents here.
}
</p>
<p>The keyboard short cut to apply (must be something like : M2+M3+F10 for ALT SHIFT F10) </p>
<p>
This key sequence should consist of one or more key strokes. Key strokes are separated by spaces. Key strokes consist of one or more keys held down at the same time. This should be zero or more modifier keys, and one other key. The keys are separated by the <code>+</code> character.
</p>
<p>
The recognized modifiers keys are <code>M1</code>, <code>M2</code>, <code>M3</code>, <code>M4</code>, <code>ALT</code>, <code>COMMAND</code>, <code>CTRL</code>, and <code>SHIFT</code>. The "M" modifier keys are a platform-independent way of representing keys, and these are generally preferred. <code>M1</code> is the <code>COMMAND</code> key on MacOS X, and the <code>CTRL</code> key on most other platforms. <code>M2</code> is the <code>SHIFT</code> key. <code>M3</code> is the <code>Option</code> key on MacOS X, and the <code>ALT</code> key on most other platforms. <code>M4</code> is the <code>CTRL</code> key on MacOS X, and is undefined on other platforms.
Since <code>M2+M3+<Letter></code> (<code>Alt+Shift+<Letter></code>) is reserved on MacOS X for writing special characters, such bindings are commonly undefined for <code>platform="carbon"</code> and redefined as <code>M1+M3+<Letter></code>.
</p>
<p>
The actual key is generally specified simply as the ASCII character, in uppercase. So, for example <code>F</code> or <code>,</code> are examples of such keys. However, there are some special keys; keys that have no printable ASCII representation. The following is a list of the current special keys: <code>ARROW_DOWN</code>, <code>ARROW_LEFT</code>, <code>ARROW_RIGHT</code>, <code>ARROW_UP</code>, <code>BREAK</code>, <code>BS</code>, <code>CAPS_LOCK</code>, <code>CR</code>, <code>DEL</code>, <code>END</code>, <code>ESC</code>, <code>F1</code>, <code>F2</code>, <code>F3</code>, <code>F4</code>, <code>F5</code>, <code>F6</code>, <code>F7</code>, <code>F8</code>, <code>F9</code>, <code>F10</code>, <code>F11</code>, <code>F12</code>, <code>F13</code>, <code>F14</code>, <code>F15</code>, <code>FF</code>, <code>HOME</code>, <code>INSERT</code>, <code>LF</code>, <code>NUL</code>, <code>NUM_LOCK</code>, <code>NUMPAD_0</code>, <code>NUMPAD_1</code>, <code>NUMPAD_2</code>, <code>NUMPAD_3</code>, <code>NUMPAD_4</code>, <code>NUMPAD_5</code>, <code>NUMPAD_6</code>, <code>NUMPAD_7</code>, <code>NUMPAD_8</code>, <code>NUMPAD_9</code>, <code>NUMPAD_ADD</code>, <code>NUMPAD_DECIMAL</code>, <code>NUMPAD_DIVIDE</code>, <code>NUMPAD_ENTER</code>, <code>NUMPAD_EQUAL</code>, <code>NUMPAD_MULTIPLY</code>, <code>NUMPAD_SUBTRACT</code>, <code>PAGE_UP</code>, <code>PAGE_DOWN</code>, <code>PAUSE</code>, <code>PRINT_SCREEN</code>, <code>SCROLL_LOCK</code>, <code>SPACE</code>, <code>TAB</code> and <code>VT</code>.
</p>
<p>
We also understand some alternative names for some common special keys. For example, we accept both <code>ESC</code> and <code>ESCAPE</code>, and <code>CR</code>, <code>ENTER</code> and <code>RETURN</code> are all the same.
</p>
<p>
It is also strongly recommended that you keep the key sequences short. One or two is the most you should need. Use contexts to give key sequences different meanings in different parts of your application. At the very most, you should not use any key sequence that contains more than four key strokes.
</p>
Description of the spy
Path to the icon of this spy (used in the E4 spies window toolbar).
2021-12
Here is an example of usage. Associate icon, name and shorcut to the spy part to be displayed
This is the sample definition for the context spy part.
<p>
<pre>
<extension point="org.eclipse.tools.spy.core.spyPart">
<spyPart
description="Context Spy to understand what is behind the scene of injection"
icon="icons/annotation_obj.png"
name="Context spy"
part="org.eclipse.tools.spy.context.ContextSpyPart"
shortcut="M2+M3+F10">
</spyPart>
</extension>
</pre>
</p>
The value of the <samp>part</samp> element's <samp>class</samp> attribute must be a simple POJO displaying the 'spied' information.
The PDE project provides multiple implementations of this extension point :
<ul>
<li> the live model editor (ie : model spy) </li>
<li> the context spy (to display E4 contexts)</li>
<li> the css spy (to display css information)</li>
</ul>
© 2015 - 2024 Weber Informatics LLC | Privacy Policy