My Eclipse Diary http://www.javawiki.org Expressions developing RCP Thu, 06 Jul 2006 22:01:53 +0000 http://wordpress.org/?v=2.0.2 en javawiki.org becomes richclient2.eu http://www.javawiki.org/2006_07_06/javawikiorg-becomes-richclient2eu/ http://www.javawiki.org/2006_07_06/javawikiorg-becomes-richclient2eu/#comments Thu, 06 Jul 2006 22:01:53 +0000 Administrator Blog http://www.javawiki.org/2006_07_06/javawikiorg-becomes-richclient2eu/ …the rest remains constant. My employer decided to host my expressions about the eclipse-framework and prepared a new blog, where also other client-technologies will be mentioned and is accessible under http://www.richclient2.eu.

]]> http://www.javawiki.org/2006_07_06/javawikiorg-becomes-richclient2eu/feed/ A SWT Calendar widget http://www.javawiki.org/2006_04_10/a-swt-calendar-widget/ http://www.javawiki.org/2006_04_10/a-swt-calendar-widget/#comments Mon, 10 Apr 2006 19:57:08 +0000 Administrator SWT http://www.javawiki.org/2006_04_10/a-swt-calendar-widget/ Today I want to show how to use of the open-source project SWT-Calendar. With a few lines of code you can implement a wonderful small calendar widget for SWT, that is not delivered by default.

I’ve written a tiny RCP where you can select a date.

Calendar RCP
If you click on the text-field you can edit and save a date. This dialog is very easy to integrate in your RCP, will preselect the date of the text-field and will solve all your problems with the missing calendar-widget. :)
The Calendar Dialog

Downloads
Download the Calendar-Demo as Plug-In (Source included - 56kByte)
Download the Calendar-Demo as RCO (Source inluded - 6,2Mbyte)

]]> http://www.javawiki.org/2006_04_10/a-swt-calendar-widget/feed/ Getting rid of “Convert Line Delimiters to” http://www.javawiki.org/2006_03_20/getting-rid-of-convert-line-delimiters-to/ http://www.javawiki.org/2006_03_20/getting-rid-of-convert-line-delimiters-to/#comments Mon, 20 Mar 2006 19:57:09 +0000 Administrator Uncategorized RCP http://www.javawiki.org/?p=14 If you're having dependencies to org.eclipse.ui.ide and you launch your RCP you'll automatically get an entry in the menu-bar that is called "Convert Line Delimiters to" and also "Last Edit Location", although you don't need it. To remove this entries place the following lines in your ApplicationActionBarAdvisor

PLAIN TEXT
JAVA:
  1.  
  2. ActionSetRegistry reg = WorkbenchPlugin.getDefault().getActionSetRegistry();
  3. IActionSetDescriptor[] actionSets = reg.getActionSets();
  4. // removing annoying gotoLastPosition Message.
  5. String actionSetId = "org.eclipse.ui.edit.text.actionSet.navigation"; //$NON-NLS-1$
  6. for (int i = 0; i <actionSets.length; i++)
  7. {
  8.     if (!actionSets[i].getId().equals(actionSetId))
  9.         continue;
  10.     IExtension ext = actionSets[i].getConfigurationElement()
  11.         .getDeclaringExtension();
  12.     reg.removeExtension(ext, new Object[] { actionSets[i] });
  13. }
  14. // Removing convert line delimiters menu.
  15. actionSetId = "org.eclipse.ui.edit.text.actionSet.convertLineDelimitersTo"; //$NON-NLS-1$
  16. for (int i = 0; i <actionSets.length; i++)
  17. {
  18.     if (!actionSets[i].getId().equals(actionSetId))
  19.         continue;
  20.     IExtension ext = actionSets[i].getConfigurationElement()
  21.         .getDeclaringExtension();
  22.     reg.removeExtension(ext, new Object[] { actionSets[i] });
  23. }
  24.  
  25.  
]]> http://www.javawiki.org/2006_03_20/getting-rid-of-convert-line-delimiters-to/feed/ JRE-Bundling with the Look & Feel of the current XP-Theme http://www.javawiki.org/2006_03_19/jre-bundling-with-the-look-feel-of-the-current-xp-theme/ http://www.javawiki.org/2006_03_19/jre-bundling-with-the-look-feel-of-the-current-xp-theme/#comments Sun, 19 Mar 2006 17:19:33 +0000 Administrator RCP http://www.javawiki.org/?p=13 It is always recommended to deliver a JRE with your Eclipse-Product, because it has tow major advantages.

  1. The client needn't to install java (probably he doesn't have the rights or the competence).
  2. You can be sure that all your clients use the same version and vendor of the vm.

But theres also a great advantage: Sun doesn't provide by default a manifest-file for displaying the widgets in the current theme of your operating-system (see http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178745), but uses the default look&feel of Windows. To fix this you need to the javaw.exe.manifest, located in your org.eclipse.swt.win32.win32.x86_x.y.z.jar-Plugin Package.

To bundle your VM, just create a folder "jre" in your [Eclipse-Root]-Directory copy the vm, take the Manifest-file and copy it to [Eclipse-Root]/jre/bin

]]> http://www.javawiki.org/2006_03_19/jre-bundling-with-the-look-feel-of-the-current-xp-theme/feed/ Enhancing the Combo-Widget with Images http://www.javawiki.org/2006_03_03/enhancing-the-combo-widget-with-images/ http://www.javawiki.org/2006_03_03/enhancing-the-combo-widget-with-images/#comments Thu, 02 Mar 2006 23:32:14 +0000 Administrator SWT http://www.javawiki.org/?p=12 Probably you was already faced with the requirement to add small icons to your pulldowns. That looks very nice, but unfortunately there is no common SWT-Widget to realize this.
Fortunately the Eclipse-Framework is OpenSource and we can reprodruce the structure of a SWT-ComboBox. A Combo is not more than a text-field and a small button with an arrow. In addition is a event-handler implemented that shows a Composite as a tooltip with the entries of the "combo-list". We just have to take this class and change the structure of the content. We don't want to have a org.eclipse.swt.widgets.List, but a org.eclipse.swt.widgets.Table with multiple org.eclipse.swt.widgets.TableItems where you can specify an image. After adjusting the access-methods we have a new cool Widget, that has the same structure and methods like the "built-in"s. :)

Screenshot

The ImageCombo in Action (as Widget in a JFace-Dialog)
The ImageCombo in Action (as Widget in a JFace-Dialog).

Usage

Update

Code-Example

The following snippet show the usage in a very simple JFace-Dialog.

PLAIN TEXT
JAVA:
  1.  
  2. /**
  3. * Very Simple Dialog with {@link org.eclipse.swt.widgets.Label}
  4. * and a Combo that has the capability to show also icons.
  5. * @author Tom Seidel
  6. *
  7. */
  8. public class SimpleDialog extends Dialog {
  9. private List list;
  10. /**
  11. * @param parentShell
  12. * @param list
  13. */
  14. protected SimpleDialog(Shell parentShell, List list) {
  15. super(parentShell);
  16. this.list = list;
  17. }
  18. /* (non-Javadoc)
  19. * @see org.eclipse.jface.dialogs.Dialog#createDialogArea(org.eclipse.swt.widgets.Composite)
  20. */
  21. protected Control createDialogArea(Composite parent) {
  22. Composite comp = (Composite) super.createDialogArea(parent);
  23. comp.setLayout(new GridLayout(2,true));
  24. Label textLabel = new Label(comp,SWT.NONE);
  25. GridData gd = new GridData(SWT.BEGINNING, SWT.CENTER, false,false);
  26. gd.widthHint = 80;
  27. textLabel.setLayoutData(gd);
  28. textLabel.setText("Your choice:"); //$NON-NLS-1$
  29.  
  30. ImageCombo combo = new ImageCombo(comp, SWT.READ_ONLY | SWT.BORDER);
  31.  
  32. Iterator iter = this.list.iterator();
  33. while (iter.hasNext()) {
  34. AbstractBaseElement element = (AbstractBaseElement) iter.next();
  35. // add text and image to the combo.
  36. combo.add(element.getId(),ImagecontributionPlugin.getDefault()
  37. .getImage(ImageContributor.getImageIdByObject(element)));
  38. }
  39. combo.setLayoutData(gd);
  40. return comp;
  41. }
  42. }
  43.  
]]> http://www.javawiki.org/2006_03_03/enhancing-the-combo-widget-with-images/feed/ Best-Practice: Developing a Model-Based Editor - Editor-Implementation http://www.javawiki.org/2006_03_03/best-practice-developing-a-model-based-editor-editor-implementation/ http://www.javawiki.org/2006_03_03/best-practice-developing-a-model-based-editor-editor-implementation/#comments Thu, 02 Mar 2006 23:10:59 +0000 Administrator Editors http://www.javawiki.org/?p=11 Developing a Model-Based Editor - TOC
  1. Intro
  2. Preparation
  3. Editor-Inputs
  4. Editor-Implementation

TBD

]]> http://www.javawiki.org/2006_03_03/best-practice-developing-a-model-based-editor-editor-implementation/feed/ Best-Practice: Developing a Model-Based Editor - Editor-Inputs http://www.javawiki.org/2006_03_03/best-practice-developing-a-model-based-editor-editor-inputs/ http://www.javawiki.org/2006_03_03/best-practice-developing-a-model-based-editor-editor-inputs/#comments Thu, 02 Mar 2006 23:08:11 +0000 Administrator Editors http://www.javawiki.org/?p=10 Developing a Model-Based Editor - TOC
  1. Intro
  2. Preparation
  3. Editor-Inputs
  4. Editor-Implementation

TBD

]]> http://www.javawiki.org/2006_03_03/best-practice-developing-a-model-based-editor-editor-inputs/feed/ Best-Practice: Developing a Model-Based Editor - Preparation http://www.javawiki.org/2006_03_02/best-practice-developing-a-model-based-editor-preparation/ http://www.javawiki.org/2006_03_02/best-practice-developing-a-model-based-editor-preparation/#comments Thu, 02 Mar 2006 00:55:25 +0000 Administrator Editors http://www.javawiki.org/?p=9 Developing a Model-Based Editor - TOC
  1. Intro
  2. Preparation
  3. Editor-Inputs
  4. Editor-Implementation

The following describes the basics of creating editors.

Declaring the extension-point

In our example we want to provide an simple editor for the object org.javawiki.model.SubProcess and a MultiPageEditor with two pages for the object org.javawiki.model.Step. At first we define the extension points.

PLAIN TEXT
XML:
  1.  
  2.  
  3.  
  4. contributorClass="org.javawiki.editors.ProcessEditorContributor"
  5. default="false"
  6. extensions="step"
  7. icon="icons/sample.gif"
  8. id="org.javawiki.editors.StepEditor"
  9. name="StepEditor"/>
  10.  
  11. contributorClass="org.javawiki.editors.ProcessEditorContributor"
  12. default="false"
  13. extensions="subp"
  14. icon="icons/sample.gif"
  15. id="org.javawiki.editors.parts.SubProcessEditor"
  16. name="SubProcessEditor"/>
  17.  
  18.  

Declaration in the plugin.xml

Managing the Object-Editor-Mapping

The assignment which object-signature is linked with a special editor is realized in the EditorContributor. This class knows the correct editor-id (specified in your plugin.xml) to a special Object.

PLAIN TEXT
JAVA:
  1.  
  2. public static final String STEP_EDITOR_ID = "org.javawiki.editors.StepEditor"; //$NON-NLS-1$
  3. public static final String SUBPROCESS_EDITOR_ID = "org.javawiki.editors.parts.SubProcessEditor"; //$NON-NLS-1$
  4.  
  5. private static Map editorMapping;
  6.  
  7. static {
  8. editorMapping = new HashMap();
  9. editorMapping.put(Step.class,STEP_EDITOR_ID);
  10. editorMapping.put(SubProcess.class,SUBPROCESS_EDITOR_ID);
  11. }
  12.  
  13. /**
  14. * Returns the correct editor id by the given
  15. * class-signature
  16. * @param clazz the class of the object that will be
  17. * edited with an Editor
  18. * @return the editor-id definded in the <code>plugin.xml</code>
  19. */
  20. public static String getEditorIdByClass(Class clazz) {
  21. return (String) editorMapping.get(clazz);
  22. }
  23.  

Open programmatically an editor

The command for opening an editor is:

PLAIN TEXT
JAVA:
  1.  
  2. PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().openEditor(
  3. myEditorInput,"editor.id.specified.in.plugin.xml");
  4.  

In the Best-Practice example we wrote a wrapper for opening an editor, the ResourceHandler, that has a Method #openEditor(final AbstractBaseElement model) and a method for checking if the model is already represented by an open editor #getEditorIndex(IEditorInput input)

Open the editor on doubleClick on an item in the JFace-Viewer

Just add an IDoubleClickListener and call the ResourceHandler

PLAIN TEXT
JAVA:
  1.  
  2. this.viewer.addDoubleClickListener(new IDoubleClickListener() {
  3. public void doubleClick(DoubleClickEvent event) {
  4. ResourceHandler.getDefault().openEditor(
  5. (AbstractBaseElement) ((IStructuredSelection) event.getSelection()).getFirstElement());
  6. }
  7. });
  8.  

Conclusion

OK, what do we have? - We have two editors defined (without any implementation), the assignment from editor to model-object and the capability to open an editor on double-click on an elemnt in the JFace-Viewer. Now only the editors are missing.

Let's take the rest!!!

]]> http://www.javawiki.org/2006_03_02/best-practice-developing-a-model-based-editor-preparation/feed/ Best-Practice: Developing a Model-Based Editor - Intro http://www.javawiki.org/2006_03_02/best-practice-developing-a-model-based-editor-intro/ http://www.javawiki.org/2006_03_02/best-practice-developing-a-model-based-editor-intro/#comments Thu, 02 Mar 2006 00:50:40 +0000 Administrator Editors http://www.javawiki.org/?p=8 Developing a Model-Based Editor - TOC
  1. Intro
  2. Preparation
  3. Editor-Inputs
  4. Editor-Implementation

A very important element of the Eclipse-Framework are editors. Editors are among views the fundamental element for user-interaction.
Eclipse provides a wonderful framework for creating editors with a reserved area (the "editor area"), where you don't have to care for common behaviour. Just implement the contribution of the input and provide an implementation for saving the edited input.

What's the goal of this article?

In the most articles and books is described how to implement an editor for editing a file with a special extension that exists physically in the workspace. But what if you want to use all the functionality the editor comes with, without writing or reading any files, but just pure Java-objects? I want to show you a way how to use in a very easy and clear way how to use simple EditorParts and MultiPageEditorParts with Forms. In addition I want to provide a strategy for managing your editors. At the end will be a eclipse-product, that has a simple view-part with a list (known from the Image-Contribution Product) . If you double-click on a list the object-specified editor will be opened and display the properties of the object, without all the workspace, file and project handling.

Requirements

  • Every Object can be handled with an editor
  • The Icon will be contributed by the ImageContributor
  • The framework knows the objects that were already "opened" by an editor.
  • A very easy way to provide new editors for new Java-Objects
  • Saving with the given "Dirty-Flag"

Screenshot of the Application

The editor application with different open editors, based on the double-clicked java-object in the ViewPart on the left.
Screenshot of the ready-to-use application

Let's roll!!!

Download the required plugins as Eclipse-Projects (Source included)
Download the Editors-Best-Practice as RCP (Source included)

]]> http://www.javawiki.org/2006_03_02/best-practice-developing-a-model-based-editor-intro/feed/ Polish up your JFace-Viewer! Sorting a table http://www.javawiki.org/2006_01_18/tidy-up-your-jface-viewer-sorting-a-table/ http://www.javawiki.org/2006_01_18/tidy-up-your-jface-viewer-sorting-a-table/#comments Wed, 18 Jan 2006 01:38:18 +0000 Administrator JFace http://www.javawiki.org/?p=7 Today I want to show how to add a sorter to your JFace-Table. The requirement is to sort descending und ascending by clicking on the TableColumn-Header.

The Viewer with an inital Sorting (Column ID)
The inital view with sorting

The ascending sorting after a click on the ID-Column header
The ascending sorting after a click on the ID-Column header.

JFace already provides sorting-functionality. We just have to provide something like an alogrithm to arrange the items. For that we implemented the CollectionSorter that uses the default Collator from ViewerSorter. Now look at the Sorter:

Initializing the Sorter with a default column

PLAIN TEXT
JAVA:
  1.  
  2. public class CollationSorter extends ViewerSorter {
  3.  
  4. private Map sortMap = new HashMap();
  5.  
  6. /**
  7. * Creates an instance of the sorter
  8. * @param tc0 the default sorter-column.
  9. */
  10. public CollationSorter(TableColumn defaultColumn) {
  11. setCurrentColumn(defaultColumn);
  12. }
  13.  
  14. /**
  15. * Pushs the current sortorder in a map which key is the
  16. * table-column.
  17. * @param column
  18. */
  19. public void pushSortCriteria(TableColumn column) {
  20. if (this.sortMap.get(column) == null) {
  21. this.sortMap.put(column,new Boolean(true));
  22. }
  23. else {
  24. boolean newSort = !((Boolean)this.sortMap.get(column)).booleanValue();
  25. this.sortMap.put(column,new Boolean(newSort));
  26. }
  27. }
  28.  
  29. /**
  30. * Asks for the current sort-order and inverts the sort-order
  31. * @param column the requested column
  32. * @return true if the sortIndex is descending, else false.
  33. */
  34. public boolean isDescending(TableColumn column) {
  35. boolean returnValue = true;
  36. if (this.sortMap.get(column) != null) {
  37. returnValue = ((Boolean)this.sortMap.get(column)).booleanValue();
  38. } else {
  39. pushSortCriteria(column);
  40. }
  41. return returnValue;
  42. }
  43.  
  44. private TableColumn currentColumn = null;
  45.  
  46. /* (non-Javadoc)
  47. * @see org.eclipse.jface.viewers.ViewerSorter#getCollator()
  48. */
  49. public int compare(Viewer viewer, Object obj1, Object obj2) {
  50. int rc = -1;
  51. // get the data
  52. AbstractBaseElement data1 = (AbstractBaseElement) obj1;
  53. AbstractBaseElement data2 = (AbstractBaseElement) obj2;
  54.  
  55. CollationKey key1 = null;
  56. CollationKey key2 = null;
  57.  
  58. if (this.currentColumn == ((TableViewer)viewer).getTable().getColumn(0)) {
  59. key1 = getCollator().getCollationKey(data1.getId());
  60. key2 = getCollator().getCollationKey(data2.getId());
  61.  
  62. }
  63. else if (this.currentColumn == ((TableViewer)viewer).getTable().getColumn(1)){
  64. key1 = getCollator().getCollationKey(data1.getName());
  65. key2 = getCollator().getCollationKey(data2.getName());
  66. }
  67. else if (this.currentColumn == ((TableViewer)viewer).getTable().getColumn(2)){
  68. key1 = getCollator().getCollationKey(data1.getDescription());
  69. key2 = getCollator().getCollationKey(data2.getDescription());
  70. }
  71. // replace null-strings with empty-strings
  72. if (key1 == null)
  73. key1 = getCollator().getCollationKey(""); //$NON-NLS-1$
  74.  
  75. if (key2 == null)
  76. key2 = getCollator().getCollationKey(""); //$NON-NLS-1$
  77.  
  78. if (isDescending(this.currentColumn)) {
  79. rc = key1.compareTo(key2);
  80. }
  81. else {
  82. rc = key2.compareTo(key1);
  83. }
  84. return rc;
  85. }
  86.  
  87. /**
  88. * Sets the sort column.
  89. * @param currentColumn The currentColumn to set.
  90. */
  91. public void setCurrentColumn(TableColumn currentColumn) {
  92. this.currentColumn  = currentColumn;
  93. pushSortCriteria(currentColumn);
  94. }
  95. }
  96.  

This sorter you can use everywhere, you just have to modify the Creation of the Collator-Keys.

Direction Indicator
This feature will be aviable in Eclipse 3.2

Download the JFace TableSorter Plugin (Requires Model-Plugin)
Download the JFace TableSorter RCP (source included)

]]> http://www.javawiki.org/2006_01_18/tidy-up-your-jface-viewer-sorting-a-table/feed/