| Home >> All >> org >> eclipse >> [ ui Javadoc ] |
Page 1 2 3
• org.eclipse.ui: Javadoc index of package org.eclipse.ui.
Package Samples:
• org.eclipse.ui.dialogs
• org.eclipse.ui.actions
• org.eclipse.ui.cheatsheets
• org.eclipse.ui.contexts
• org.eclipse.ui.commands
• org.eclipse.ui.about
• org.eclipse.ui.activities
• org.eclipse.ui.application
• org.eclipse.ui.branding
• org.eclipse.ui.contentassist
Classes:
• IWorkbenchActionConstants: Action ids for standard actions, groups in the workbench menu bar, and global actions. This interface contains constants only; it is not intended to be implemented or extended. Standard menus File menu ( M_FILE ) Edit menu ( M_EDIT ) Window menu ( M_WINDOW ) Help menu ( M_HELP ) Standard group for adding top level menus Extra top level menu group ( MB_ADDITIONS ) Global actions Undo ( UNDO ) Redo ( REDO ) Cut ( CUT ) Copy ( COPY ) Paste ( PASTE ) Delete ( DELETE ) Find ( FIND ) Select All ( SELECT_ALL ) Add Bookmark ( BOOKMARK ) Standard File menu actions Start group ( FILE_START ) End group ( ...
• AbstractUIPlugin: Abstract base class for plug-ins that integrate with the Eclipse platform UI. Subclasses obtain the following capabilities: Preferences The platform core runtime contains general support for plug-in preferences ( org.eclipse.core.runtime.Preferences ). This class provides appropriate conversion to the older JFace preference API ( org.eclipse.jface.preference.IPreferenceStore ). The method getPreferenceStore returns the JFace preference store (cf. Plugin.getPluginPreferences which returns a core runtime preferences object. Subclasses may reimplement initializeDefaultPreferences to set up any default ...
• WorkbenchAdvisor: Public base class for configuring the workbench. Note that the workbench advisor object is created in advance of creating the workbench. However, by the time the workbench starts calling methods on this class, PlatformUI.getWorkbench is guaranteed to have been properly initialized. Example of creating and running a workbench (in an IPlatformRunnable ): public class MyApplication implements IPlatformRunnable { public Object run(Object args) { WorkbenchAdvisor workbenchAdvisor = new MyWorkbenchAdvisor(); Display display = PlatformUI.createDisplay(); int returnCode = PlatformUI.createAndRunWorkbench(display, ...
• FormText: This class is a read-only text control that is capable of rendering wrapped text. Text can be rendered as-is or by parsing the formatting XML tags. Independently, words that start with http:// can be converted into hyperlinks on the fly. When configured to use formatting XML, the control requires the root element form to be used. The following tags can be children of the form element: p - for defining paragraphs. The following attributes are allowed: vspace - if set to 'false', no vertical space will be added (default is 'true') li - for defining list items. The following attributes are allowed: ...
• IntroModelRoot: The root class for the OOBE model. It loads the configuration into the appropriate classes. Model rules: if an attribute is not included in the markup, its value will be null in the model. the current page id is set silently when loading the model. You do not need the event notification on model load. Children of a given parent (ie: model root, page, or group) *must* have distinctive IDs otherwise resolving includes and extensions may fail. Containers have the concept of loading children and resolving children. At the model root level, resolving children means resolving ALL extensions of model. ...
• IWorkbenchPart: A workbench part is a visual component within a workbench page. There are two subtypes: view and editor, as defined by IViewPart and IEditorPart . A view is typically used to navigate a hierarchy of information (like the workspace), open an editor, or display properties for the active editor. Modifications made in a view are saved immediately. An editor is typically used to edit or browse a document or input object. The input is identified using an IEditorInput . Modifications made in an editor part follow an open-save-close lifecycle model. This interface may be implemented directly. For convenience, ...
• PageBookView: Abstract superclass of all multi-page workbench views. Within the workbench there are many views which track the active part. If a part is activated these views display some properties for the active part. A simple example is the Outline View , which displays the outline for the active editor. To avoid loss of context when part activation changes, these views may implement a multi-page approach. A separate page is maintained within the view for each source view. If a part is activated the associated page for the part is brought to top. If a part is closed the associated page is disposed. PageBookView ...
• IPerspectiveFactory: A perspective factory generates the initial page layout and visible action set for a page. When a new page is created in the workbench a perspective is used to define the initial page layout. If this is a predefined perspective (based on an extension to the workbench's perspective extension point) an IPerspectiveFactory is used to define the initial page layout. The factory for the perspective is created and passed an IPageLayout where views can be added. The default layout consists of the editor area with no additional views. Additional views are added to the layout using the editor area as the ...
• IIntroContentProvider: A content provider for dynamic intro content. It is initialized with the content provider site because a typical content provider would need to update its contents dynamically at runtime. And so, the site can be informed of a need to redraw its content through a call to its reflow method. The life cycle of an IIntroContentProvider is as follows: a content provider is defined in the Intro content markup file (ie: introContent.xml file) as follows: <contentProvider id="roles" class="x.y.z.ContentProvider"> <text>Some alternate text for dynamic content</text> ...
• CellLayout: Instance of this class lay out the control children of a Composite in a grid, using a simple set of rules and a simple API. This class is intended to be more predictable than GridLayout and easier to use than FormLayout , while retaining most of the power of both. The power of a CellLayout lies in the ability to control the size and resizing properties of each row and column. Unlike other layout classes, complex layouts can be created without attaching any layout data to individual controls in the layout. The various subclasses of IColumnInfo can be used to create columns with fixed width, columns ...
• IDocumentProvider: A document provider maps between domain elements and documents. A document provider has the following responsibilities: create an annotation model of a domain model element create and manage a textual representation, i.e., a document, of a domain model element create and save the content of domain model elements based on given documents update the documents this document provider manages for domain model elements to changes directly applied to those domain model elements notify all element state listeners about changes directly applied to domain model elements this document provider manages a document ...
• IActionBars: Used by a part to access its menu, toolbar, and status line managers. Within the workbench each part, editor or view, has a private set of action bars. This set, which contains a menu, toolbar, and status line, appears in the local toolbar for a view and in the window for an editor. The view may provide an implementation for pre-existing actions or add new actions to the action bars. In a workbench window there are a number of actions which are applicable to all parts. Some common examples are CUT , COPY and PASTE . These actions, known as "global actions", are contributed to the workbench window ...
• EditorPart: Abstract base implementation of all workbench editors. This class should be subclassed by clients wishing to define new editors. The name of the subclass should be given as the "class" attribute in a editor extension contributed to the workbench's view extension point (named "org.eclipse.ui.editors" ). For example, the plug-in's XML markup might contain: <extension point="org.eclipse.ui.editors"> <editor id="com.example.myplugin.ed" name="My Editor" icon="./images/cedit.gif" extensions="foo" class="com.example.myplugin.MyFooEditor" contributorClass="com.example.myplugin.MyFooEditorContributor" ...
• ForwardingDocumentProvider: A forwarding document provider is a document provider that forwards all requests to a known parent document provider. The only functional addition of the forwarding document provider is that it ensures that all documents provided to clients are appropriately set up. This document provider should be used by editors that directly or indirectly work with a TextFileDocumentProvider and do not accept that they may be provided with documents which do not contain the partitioning they work on. This can happen either because of a plug-in configuration error or when a user associates a file name or file ...
• AnnotationPreference: An annotation preference provides all the information required for handing the preferences for the presentation of annotations of a specified type. The type can be changed and retrieved using the getAnnotationType and setAnnotationType methods. For each preference, getter and setter methods are provided. Preferences that may be changed by the user also have a corresponding key that can be used to obtain the currently set value from an IPreferenceStore . The following annotation preferences are covered: Display Preferences controlling how and where annotations are shown as text background highlighting ...
• EditorInputTransfer: The EditorInputTransfer class is used to transfer an IEditorInput and corresponding editorId from one part to another in a drag and drop operation. Only opening of internal editors is supported. In every drag and drop operation there is a DragSource and a DropTarget . When a drag occurs a Transfer is used to marshall the drag data from the source into a byte array. If a drop occurs another Transfer is used to marshall the byte array into drop data for the target. This class can be used for a Viewer or an SWT component directly. A singleton is provided which may be serially reused (see getInstance ...
• IActionFilter: An adapter which performs action filtering. Within the workbench a plugin may extend the actions which appear in the context menu for any object. The visibility of each action extension is controlled by action filtering. By default, the workbench will filter each action extension using the objectClass and optional nameFilter attributes defined in xml. If the action extension passes this test the action will be added to the context menu for the object. In some situations the object class and name are not enough to describe the intended target action. In those situations an action extension may define ...
• WorkbenchImages: This class provides convenience access to many of the resources required by the workbench. The class stores some images as descriptors, and some are stored as real Images in the registry. This is a pure speed-space tradeoff. The trick for users of this class is that images obtained from the registry (using getImage()), don't require disposal since they are shared, while images obtained using getImageDescriptor() will require disposal. Consult the declareImages method to see if a given image is declared as a registry image or just as a descriptor. If you change an image from being stored as a descriptor ...
• SourceViewerDecorationSupport: Support class used by text editors to draw and update decorations on the source viewer and its rulers. An instance of this class is independent of a certain editor and must be configured with the needed preference keys and helper objects before it can be used. Once configured, an instance may be installed (see install 55 ) on a preference store, from then on monitoring the configured preference settings and changing the respective decorations. Calling uninstall 55 will unregister the listeners with the preferences store and must be called before changing the preference store by another call to ...
• ITextEditor: Interface to a text editor. This interface defines functional extensions to IEditorPart as well as the configuration capabilities of a text editor. Text editors are configured with an IDocumentProvider which delivers a textual presentation ( IDocument ) of the editor's input. The editor works on the document and forwards all input element related calls, such as save , to the document provider. The provider also delivers the input's annotation model which is used to control the editor's vertical ruler. Clients may implement this interface from scratch, but the recommended way is to subclass the ...
• ContentOutline: Main class for the Content Outline View. This standard view has id "org.eclipse.ui.views.ContentOutline" . When a content outline view notices an editor being activated, it asks the editor whether it has a content outline page to include in the outline view. This is done using getAdapter : IEditorPart editor = ...; IContentOutlinePage outlinePage = (IContentOutlinePage) editor.getAdapter(IContentOutlinePage.class); if (outlinePage != null) { // editor wishes to contribute outlinePage to content outline view } If the editor supports a content outline page, the editor instantiates and configures ...
• CustomizableIntroPart: A re-usable intro part that the Eclipse platform uses for its Out of the Box Experience. It is a customizable intro part where both its presentation, and its content can be customized based on a configuration. Both are contributed using the org.eclipse.ui.intro.intro.config extension point. There are two two presentation: an SWT browser based presentatin, and a UI forms presentation. Based on the configuration, one is chosen on startup. If a Browser based prsentation is selected, and the intro is being loaded on a platform that does not support the SWT Browser control, the default behavior is to ...
• Form: Form is a custom control that renders a title and an optional background image above the body composite. It can be used alone when part of parents that are scrolled. If scrolling is required, use ScrolledForm instead because it has an instance of Form and adds scrolling capability. Form can have a title if set. If not set, title area will not be left empty - form body will be resized to fill the entire form. Form can have a background image behind the title text. The image can be painted as-is, or tiled as many times as needed to fill the title area. Form has a custom layout manager that is wrap-enabled. ...
• PageEventAction: The abstract superclass for actions that listen to page activation and open/close events. This implementation tracks the active page (see getActivePage ) and provides a convenient place to monitor page lifecycle events that could affect the availability of the action. Subclasses must implement the following IAction method: run - to do the action's work Subclasses may extend any of the IPartListener methods if the action availablity needs to be recalculated: partActivated partDeactivated partOpened partClosed partBroughtToTop Subclasses may extend any of the IPageListener methods if the action availablity ...
• CacheWrapper: This class wraps a control with a complex computeSize method. It uses caching to reduce the number of times the control's computeSize method is called. This allows controls (such as Coolbars and wrapping text) with slow computeSize operations to be used inside layouts and composites that use inefficient caching. For example, you want to use Coolbar A inside composite B. Rather than making A a direct child of B, place it inside a CacheWrapper and insert the CacheWrapper into B. Any layout data that would normally be attached to the control itself should be attached to the wrapper instead: // Unoptimized ...
| Home | Contact Us | Privacy Policy | Terms of Service |