Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "E4/UI/Running the contacts demo"

< E4‎ | UI
(Setup steps)
(Prerequisites)
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Image:E4-contacts-demo.PNG|thumb|400px|A screenshot of the e4 contacts demo as of 1.0M2.]]
+
[[Image:E4-contacts-demo.PNG|thumb|400px|A screenshot of the e4 contacts demo.]]
:''The instructions provided on this page were last updated for the e4 [http://download.eclipse.org/e4/downloads/drops/S-1.0M2-200911201200/index.html 1.0M2 milestone].''
+
:''The instructions provided on this page were last updated for the Eclipse 4.0 release.
  
 
The '''e4 contacts demo''' showcases an e4-based RCP application that allows the user to view and edit vCards.
 
The '''e4 contacts demo''' showcases an e4-based RCP application that allows the user to view and edit vCards.
  
 
==Prerequisites==
 
==Prerequisites==
*[[E4/Install|e4 SDK installation]]
+
#Download an Eclipse 4.0 SDK [http://download.eclipse.org/e4/sdk/ here].
 +
#Unzip/Untar the file as you would with a regular Eclipse SDK download.
 +
#Start up Eclipse.
 +
#See [[E4/UI/Running_the_compatibility_demo]] for extra bundles you might need to work with the contacts demo.
  
 
==Features==
 
==Features==
 
*Displays the usage and definition of commands, handlers, and keybindings in e4
 
*Displays the usage and definition of commands, handlers, and keybindings in e4
**Ctrl+D switches to the "Dark Theme"
 
**Ctrl+L switches to the "Bright Theme"
 
 
**Ctrl+5, X will exit the application (demonstrates multistroke keybindings)
 
**Ctrl+5, X will exit the application (demonstrates multistroke keybindings)
 
**Ctrl+S to save the vCard that's currently opened
 
**Ctrl+S to save the vCard that's currently opened
Line 17: Line 18:
  
 
==Setup steps==
 
==Setup steps==
#Download an e4 SDK [http://download.eclipse.org/e4/downloads/ here].
 
#Unzip/Untar the file as you would with a regular Eclipse SDK download.
 
#Start up Eclipse.
 
 
#Select File > Import... and select CVS > Projects from CVS, click Next.
 
#Select File > Import... and select CVS > Projects from CVS, click Next.
#Copy the CVS repository location and paste it into the "Host" field to populate the wizard page: :pserver:anonymous@dev.eclipse.org:/cvsroot/eclipse
+
#Copy the CVS repository location and paste it into the "Host" field to populate the wizard page: <code>:pserver:anonymous@dev.eclipse.org:/cvsroot/eclipse</code>
 
#You should see "Host: dev.eclipse.org, Repository path: /cvsroot/eclipse, User: anonymous, Connection type: pserver".
 
#You should see "Host: dev.eclipse.org, Repository path: /cvsroot/eclipse, User: anonymous, Connection type: pserver".
#Click Next and select the second option Use an existing module.
+
#Click 'Next' and select the second option 'Use an existing module'.
#Drill down as follows: e4 > org.eclipse.e4.ui > examples and select org.eclipse.e4.demo.contacts. Click Next.
+
#Drill down as follows: <code>e4</code> > <code>releng</code> > and select <code>org.eclipse.e4.ui.releng</code>. Click 'Next'.
#Important: Do not click Finish just yet. Advance to the last wizard page using Next, then click on Refresh Tags. Select the tag appropriate for your installation (e.g. M3, I20100112-0800, R0_9 ... you can find your installation's build tag in the Help > About Eclipse SDK dialog) and click Finish.
+
#Important: Do not click Finish just yet. Advance to the last wizard page using Next, then click on Refresh Tags. Select the tag appropriate for your installation (you probably want v20100727-1415) and click Finish.
#This will check out one project into your workspace. Expand the project in the Package Explorer and open the contacts.product file.  
+
#This will check out a project into your workspace. Expand the project in the 'Package Explorer' view and then right-click on the <code>e4.ui.examples.psf</code> file and then select 'Import Project Set...'.
#In the opened editor, navigate to the 'Testing' section in the 'General' tab.
+
#Click OK to reuse the same repository you previously used above. If you are prompted for login credentials, simply enter in 'anonymous' for your user name.
#Click the 'Launch an Eclipse application' hyperlink. The demo should now come up.
+
#You will now have a couple more projects in your workspace. Expand the 'org.eclipse.e4.demo.contacts' project and open the contacts.product file.  
 +
#In the opened editor, navigate to the 'Testing' section in the 'General' tab. It should be located in the bottom left hand side of the editor.
 +
#Click the 'Launch an Eclipse application' hyperlink. The demo should then launch.
  
 
==Known issues==
 
==Known issues==
#The splash screen does not currently go away, see {{bug|277463}}.
+
*The splash screen does not currently go away, see {{bug|277463}}.
 +
*The examples PSF works correctly with each milestone, but is invalid for I builds, see {{bug|298011}}.
 +
*Contact demo fails to launch from the .product file.  Open the Run Configuration dialog and hit Run, see {{bug|303973}}.

Revision as of 14:20, 28 July 2010

A screenshot of the e4 contacts demo.
The instructions provided on this page were last updated for the Eclipse 4.0 release.

The e4 contacts demo showcases an e4-based RCP application that allows the user to view and edit vCards.

Prerequisites

  1. Download an Eclipse 4.0 SDK here.
  2. Unzip/Untar the file as you would with a regular Eclipse SDK download.
  3. Start up Eclipse.
  4. See E4/UI/Running_the_compatibility_demo for extra bundles you might need to work with the contacts demo.

Features

  • Displays the usage and definition of commands, handlers, and keybindings in e4
    • Ctrl+5, X will exit the application (demonstrates multistroke keybindings)
    • Ctrl+S to save the vCard that's currently opened
  • Shows how CSS can be used to skin an application (note that the CSS engine does not have any particular dependencies on e4 technologies and can be reused in an Eclipse 3.x-based application)
  • Editing a vCard will cause the part to display the '*' dirty affordance (demonstrates the life cycle of saveable parts)

Setup steps

  1. Select File > Import... and select CVS > Projects from CVS, click Next.
  2. Copy the CVS repository location and paste it into the "Host" field to populate the wizard page: :pserver:anonymous@dev.eclipse.org:/cvsroot/eclipse
  3. You should see "Host: dev.eclipse.org, Repository path: /cvsroot/eclipse, User: anonymous, Connection type: pserver".
  4. Click 'Next' and select the second option 'Use an existing module'.
  5. Drill down as follows: e4 > releng > and select org.eclipse.e4.ui.releng. Click 'Next'.
  6. Important: Do not click Finish just yet. Advance to the last wizard page using Next, then click on Refresh Tags. Select the tag appropriate for your installation (you probably want v20100727-1415) and click Finish.
  7. This will check out a project into your workspace. Expand the project in the 'Package Explorer' view and then right-click on the e4.ui.examples.psf file and then select 'Import Project Set...'.
  8. Click OK to reuse the same repository you previously used above. If you are prompted for login credentials, simply enter in 'anonymous' for your user name.
  9. You will now have a couple more projects in your workspace. Expand the 'org.eclipse.e4.demo.contacts' project and open the contacts.product file.
  10. In the opened editor, navigate to the 'Testing' section in the 'General' tab. It should be located in the bottom left hand side of the editor.
  11. Click the 'Launch an Eclipse application' hyperlink. The demo should then launch.

Known issues

  • The splash screen does not currently go away, see bug 277463.
  • The examples PSF works correctly with each milestone, but is invalid for I builds, see bug 298011.
  • Contact demo fails to launch from the .product file. Open the Run Configuration dialog and hit Run, see bug 303973.

Back to the top