Jump to: navigation, search

Difference between revisions of "FAQ Pages, parts, sites, windows: What is all this stuff?"

 
 
(6 intermediate revisions by 3 users not shown)
Line 4: Line 4:
 
called in Eclipse Speak?.” In an effort to assuage the suffering of new users,  
 
called in Eclipse Speak?.” In an effort to assuage the suffering of new users,  
 
the following is a mile-high view of the pieces of the Eclipse UI.
 
the following is a mile-high view of the pieces of the Eclipse UI.
 
 
  
 
The term used to represent the entire UI is <i>workbench</i>.  The workbench
 
The term used to represent the entire UI is <i>workbench</i>.  The workbench
Line 14: Line 12:
 
Note that dialogs, wizards, and other transient pop-ups are  
 
Note that dialogs, wizards, and other transient pop-ups are  
 
not called workbench windows.   
 
not called workbench windows.   
 
 
  
 
At the top of each window is the <i>title bar</i>, typically
 
At the top of each window is the <i>title bar</i>, typically
Line 26: Line 22:
 
are shown; the far-right corner of the status line is called  
 
are shown; the far-right corner of the status line is called  
 
the <i>progress indicator</i>.
 
the <i>progress indicator</i>.
 
 
 
  
 
The main body of a workbench window is represented by the  
 
The main body of a workbench window is represented by the  
Line 34: Line 27:
 
parts</i>, which come in two varieties: <i>views</i> and <i>editors</i>.  The initial size
 
parts</i>, which come in two varieties: <i>views</i> and <i>editors</i>.  The initial size
 
and orientation of the parts in the page are determined by a <i>perspective</i>.
 
and orientation of the parts in the page are determined by a <i>perspective</i>.
 
 
 
  
 
Parts interact with the rest of the window via their <i>site</i>.   
 
Parts interact with the rest of the window via their <i>site</i>.   
Line 47: Line 37:
 
page, inside a workbench window, owned by the workbench.
 
page, inside a workbench window, owned by the workbench.
  
 +
[[Image:FAQ_views.png]]
  
 
+
'''Figure 9.1'''&nbsp;&nbsp;Spider diagram of site parts
&nbsp;&nbsp;&nbsp;&nbsp;<img src=../images/views.png>
+
 
+
 
+
&nbsp;&nbsp;&nbsp;&nbsp;'''Figure 9.1'''&nbsp;&nbsp;
+
Spider diagram of site parts
+
 
+
 
+
  
 
In addition, sites bring together that functionality  
 
In addition, sites bring together that functionality  
 
that different parts of the workbench had in common but could not be  
 
that different parts of the workbench had in common but could not be  
 
expressed well in a single inheritance hierarchy.
 
expressed well in a single inheritance hierarchy.
 
 
 
 
 
 
  
 
== See Also: ==
 
== See Also: ==
 +
*[[FAQ_What_is_the_difference_between_a_perspective_and_a_workbench_page%3F]]
 +
*[[FAQ_What_is_a_view%3F]]
 +
*[[FAQ_What_is_the_difference_between_a_view_and_an_editor%3F]]
  
 
+
{{Template:FAQ_Tagline}}
[[FAQ_What_is_the_difference_between_a_perspective_and_a_workbench_page%3F]]
+
 
+
 
+
[[FAQ_What_is_a_view%3F]]
+
 
+
 
+
[[FAQ_What_is_the_difference_between_a_view_and_an_editor%3F]]
+
 
+
<hr><font size=-2>This FAQ was originally published in [http://www.eclipsefaq.org Official Eclipse 3.0 FAQs]. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1.0].</font>
+

Latest revision as of 16:57, 10 November 2006

Denizens of the Eclipse newsgroups, clearly expressing frustration with the overwhelming sea of terms, have been known to ask, “What is the Eclipsian word for X?,” or “What is that thingy called in Eclipse Speak?.” In an effort to assuage the suffering of new users, the following is a mile-high view of the pieces of the Eclipse UI.

The term used to represent the entire UI is workbench. The workbench itself has no physical manifestation, but the workbench object is used to access most of the general APIs and services available in the generic UI. The workbench is displayed in one or more workbench windows. These basic top-level windows make up an Eclipse application. Note that dialogs, wizards, and other transient pop-ups are not called workbench windows.

At the top of each window is the title bar, typically a native widget with a title and controls for resizing and closing. Next comes the menu bar, and after that is the cool bar. The cool bar is a fancy term for a bar of buttons that can be dragged around and reorganized across multiple lines. On the left, right, or bottom, depending on user preference, is the fast view bar, where fast views—iconified views—are stored. At the bottom is the status line, where various bits of information are shown; the far-right corner of the status line is called the progress indicator.

The main body of a workbench window is represented by the workbench page, which in turn is made up of workbench parts, which come in two varieties: views and editors. The initial size and orientation of the parts in the page are determined by a perspective.

Parts interact with the rest of the window via their site. The site is not a visible entity but simply an API mechanism to separate the methods that operate on the view from the methods that operate on controls and services outside the view. This allows the workbench implementers to add new features to the sites without breaking all the plug-ins that implement the parts. Figure 9.1 Spider graph shows how a view (ContentOutline) and an editor (WelcomeEditor) each has its own site, which is hosted by a page, inside a workbench window, owned by the workbench.

FAQ views.png

Figure 9.1  Spider diagram of site parts

In addition, sites bring together that functionality that different parts of the workbench had in common but could not be expressed well in a single inheritance hierarchy.

See Also:


This FAQ was originally published in Official Eclipse 3.0 FAQs. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the Eclipse Public License v1.0.