Difference between revisions of "JFaceSnippets"

From Eclipsepedia

Jump to: navigation, search
(Removed out-dated Snippet #023)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
JFace-Snippets are small easy understandable programming example how to use JFace API.
+
JFace-Snippets are small easy understandable programming example how to use JFace API. To browse the examples, navigate to the[http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets examples GIT repository].  
 
+
To browse examples, navigate to [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets examples GIT repository]. (Historically examples were stored in [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.jface.snippets/ CVS repository].)
+
  
 
== Dialogs ==
 
== Dialogs ==
Line 151: Line 149:
 
Demonstrates creation of tooltips for cells for pre 3.3 users  
 
Demonstrates creation of tooltips for cells for pre 3.3 users  
  
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet032TableTreeViewer.java Snippet032TableTreeViewer]  ===
+
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet034CellEditorPerRow.java Snippet034CellEditorPerRowNewAPI]  ===
  
Demonstrates a JFace-Viewer ontop of the old TableTree-Widget.
+
Demonstrates different CellEditor-Types in one COLUMN of JFace-Viewers  
 
+
'''NOTE: DO NOT USE THIS VIEWER ANY MORE. IT IS ONLY KEPT FOR BACKWARDS COMPLIANCE. USE TREEVIEWER INSTEAD.'''
+
 
+
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet033CellEditorPerRowPre33.java Snippet033CellEditorPerRowPre33]  ===
+
 
+
Demonstrates how one can handle different CellEditors-Types in one COLUMN before 3.3 and how difficult this has been.
+
 
+
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet034CellEditorPerRowNewAPI.java Snippet034CellEditorPerRowNewAPI]  ===
+
 
+
Demonstrates different CellEditor-Types in one COLUMN with 3.3-API of JFace-Viewers  
+
  
 
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet035TableCursorCellHighlighter.java Snippet035TableCursorCellHighlighter]  ===
 
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet035TableCursorCellHighlighter.java Snippet035TableCursorCellHighlighter]  ===
Line 259: Line 247:
 
Example for full feature cell navigation until bug 230955 is fixed  
 
Example for full feature cell navigation until bug 230955 is fixed  
  
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet059CellNavigationIn33.java Snippet059CellNavigationIn33]  ===
 
 
Example for full feature cell navigation in 3.3. This snippet uses internal API by reflection so its not guaranteed to work for ever. The problem of invisible cells is fixed in 3.4. The problem with horizontal scrolling is going to be fixed in 3.5.
 
  
 
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet060TextCellEditorWithContentProposal.java Snippet060TextCellEditorWithContentProposal]  ===
 
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet060TextCellEditorWithContentProposal.java Snippet060TextCellEditorWithContentProposal]  ===
Line 271: Line 256:
 
Full featured native looking viewer with checkboxes in an arbitary column  
 
Full featured native looking viewer with checkboxes in an arbitary column  
  
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet62TextAndDialogCellEditor.java Snippet62TextAndDialogCellEditor] ===
+
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/viewers/Snippet62TextAndDialogCellEditor.java Snippet062TextAndDialogCellEditor] ===
  
 
Demonstrates usage of TextAndDialogCellEditor. The email column uses the TextAndDialogCellEditor; othe columns use ordinary TextCellEditor.
 
Demonstrates usage of TextAndDialogCellEditor. The email column uses the TextAndDialogCellEditor; othe columns use ordinary TextCellEditor.
Line 285: Line 270:
 
Demonstrates usage of new JFace 3.3 to show really cool ToolTips for your controls  
 
Demonstrates usage of new JFace 3.3 to show really cool ToolTips for your controls  
  
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/window/Snippet023TreeViewerCustomTooltips.java Snippet023TreeViewerCustomTooltips]  ===
+
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/window/Snippet031TableStaticTooltip.java Snippet031TableStaticTooltip]  ===
 
+
Demonstrates creation of ToolTips for users pre 3.3.
+
 
+
=== [http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/examples/org.eclipse.jface.snippets/Eclipse%20JFace%20Snippets/org/eclipse/jface/snippets/window/Snippet031TableStaticTooltip.java Snippet031TableStaticTooltip.java]  ===
+
 
+
Demonstrates creation of ToolTips for Tables without using the JFace-Viewers API but only JFace-Tooltips
+
 
+
  
 +
Demonstrates creation of ToolTips for Tables without using the JFace-Viewers API but only JFace-Tooltips
  
 
== Wizard ==
 
== Wizard ==
Line 300: Line 279:
  
 
Demonstrates how to work with JFace-Wizards and fill a TableViewer from a Background-Thread without blocking the UI showing a progress bar in the meanwhile  
 
Demonstrates how to work with JFace-Wizards and fill a TableViewer from a Background-Thread without blocking the UI showing a progress bar in the meanwhile  
 +
  
 
[[Category:Snippets]] [[Category:RCP]] [[Category:Platform_UI]]
 
[[Category:Snippets]] [[Category:RCP]] [[Category:Platform_UI]]

Latest revision as of 10:23, 6 May 2014

JFace-Snippets are small easy understandable programming example how to use JFace API. To browse the examples, navigate to theexamples GIT repository.

Contents

[edit] Dialogs

[edit] Snippet012DialogWithImageButtons

Demonstrates usage of Icons in Buttons of Dialogs

[edit] Layout

[edit] Snippet013GridLayoutFactory

Demonstrates usage of the GridLayoutFactory to make more readable

[edit] Snippet016TableLayout

Demonstrates (dynamic)layout support for TableColumns available as of JFace 3.3

[edit] Snippet027TreeLayout

Demonstrates (dynamic)layout support for TreeColumns available as of JFace 3.3

[edit] Viewers

[edit] Snippet001TableViewer

Demonstrates a simply TableViewer with one column. It holds all important classes used for all Table-like JFace-Viewers (LabelProvider,IStructuredContentProvider)

Snippet1.png

[edit] Snippet002TreeViewer

Demonstrates a simply TreeViewer with one column. It describes all important classes used for all Tree-like JFace-Viewers (LabelProvider,ITreeContentProvider)

Snippet2.png

[edit] Snippet003TableLabelProvider

Demonstrates tables with more than one column and the usage of ITableLabelProvider

File:Snippet3.png

[edit] Snippet004HideSelection

Demonstrates how the selection can be hidden when the user click in a tablerow/column which doesn't hold any information. The standard behaviour of SWT-Table is to leave the selection on the last column. This snippet removes the selection if the user clicks in an area not selectable

Snippet004.png

[edit] Snippet005TreeCustomMenu

Demonstrates how to create a different context menu depending on which item in the tree is currently selected this can also be used with a table of course

Snippet005.png

[edit] Snippet006TableMultiLineCells

Demonstrates first use case for the new OwnerDraw-Support added to JFace in 3.3 (available at SWT-Level since 3.2). This example uses the new Viewers API in this special case the OwnerDrawLabelProvider to make items with more than one line of text.

Snippet006.png

[edit] Snippet007FullSelection

Demonstrates how you can use a use inline editing in tables with multiple columns which requires to use SWT.FULL_SELECTION but hiding the selection from the user.

Snippet007.png

[edit] Snippet008RevealElement

Demonstrates how you can scroll a TableViewer to the specific model element using TableViewer#reveal(Object)

Snippet008.png

[edit] Snippet009CellEditors

Demonstrates minimal example when trying to add inline editing to tables to get familiar with the various classes needed (3.2 API)

Snippet009.png

[edit] Snippet010OwnerDraw

Demonstrates usage of new OwnerDraw-Support feature provided by JFace in 3.3(available in SWT since 3.2). This example uses the new Viewers API in this special case the OwnerDrawLabelProvider.

Snippet010.png

[edit] Snippet011CustomTooltips

Demonstrates usage of new custom tooltip support in 3.3 used to provide a tooltip for each cell in TableViewer

[edit] Snippet013TableViewerNoMandatoryLabelProvider

Demonstrates usage of none mandatory LabelProviders in TableViewers to set colors and fonts with 3.2-API

[edit] Snippet014TreeViewerNoMandatoryLabelProvider

Demonstrates usage of none mandatory LabelProviders in TreeViewers to set colors and font with 3.2-API

[edit] Snippet015CustomTooltipsForTree

Demonstrates usage of new custom tooltip support in 3.3 used to provide a tooltip for each cell in a TreeViewer

[edit] Snippet017TableViewerHideShowColumns

Demonstrates hiding and showing of columns (animated)

[edit] Snippet018TableViewerAddRemoveColumnsWithEditing

Demonstrates adding/removing of columns in conjunction with inline editing which makes this a bit tougher than without it (using 3.2 API)

[edit] Snippet019TableViewerAddRemoveColumnsWithEditingNewAPI

Demonstrates adding/removing of columns in conjunction with the inline editing but with the new JFace-API who makes this a much easier and less error prone

[edit] Snippet021CellEditorsOnDoubleClick

Demonstrates editor activation on double-click with the 3.2 API which makes this fairly complex

[edit] Snippet022TableViewerRefreshNoScroll

Demonstrates how to refresh and viewer without scrolling the selection into after the refresh with 3.2 API. In 3.3 a special refresh-API for TableViewers is added.

[edit] Snippet024TableViewerExploreNewAPI

Demonstrates the base classes of 3.3 API

[edit] Snippet025TabEditing

Demonstrates how one can use the new 3.3 API to add tab-editing support to your viewer

[edit] Snippet026TreeViewerTabEditing

Demonstrates all fancy things one can do with new 3.3 API (Tab-Editing, Keyboard-Navigation from Cell to Cell, Editor-Activation with the Keyboard)

Snippet026TreeViewerTabEditing.gif

[edit] Snippet027ComboBoxCellEditors

Demonstrates usage of the ComboBoxCellEditor in JFace-Viewers

[edit] Snippet029VirtualTableViewer

Demonstrates usage of JFace-Viewers in virtual mode with an ordinary content provider (often the bottel neck is not the model but the UI). Using this Virtual viewers in conjunction with an ordinary content provider has the advantage that Sorting and Filtering is supported in 3.3.

[edit] Snippet030VirtualLazyTableViewer

Demonstrates usage of JFace-Viewer virtual mode with a lazy content provider

[edit] Snippet031TableViewerCustomTooltipsMultiSelection

Demonstrates creation of tooltips for cells for pre 3.3 users

[edit] Snippet034CellEditorPerRowNewAPI

Demonstrates different CellEditor-Types in one COLUMN of JFace-Viewers

[edit] Snippet035TableCursorCellHighlighter

Demonstrates keyboard navigation in TableViewers using a TableCursor showing the flexibility of the new cell navigation support

[edit] Snippet036FocusBorderCellHighlighter

Demonstrates keyboard navigation by highlighting the currently selected cell with a focus border showing once more the flexibility of the new cell navigation support

[edit] Snippet037FancyCustomTooltips

Demonstrates customizability of the 3.3 JFace-Support for cell tooltips using the Browser-Widget and presenting HTML

[edit] Snippet038TreeViewerInlinelEditingOldAPI

Demonstrates editing support as of 3.2 for TreeViewers

[edit] Snippet039ListViewer

Demonstrates a very simple usage of ListViewer

[edit] Snippet040TableViewerSorting

Demonstrates sorting(asc/desc) in TableViewers by clicking the column header. This snippet uses classes from JFace 3.3 but can be easily adopted to work with JFace from 3.2

[edit] Snippet041TableViewerAlternatingColors

Demonstrates how to achieve alternating row-colors with TableViewer and the new JFace 3.3 API which allows for faster algorithms and can be used in conjunction with virtual-bits to even work with big tables (e.g. 100,000 rows in this example).

[edit] Snippet042ToolTipSupportFor32API

Because ColumnViewerToolTipSupport forces one to use the new 3.3 CellLabelProvider-API it is of no use for people stuck with the old LabelProvider API. This snippet shows how a potential class for 3.2 API could look like.

[edit] Snippet043NoColumnTreeViewerKeyboardEditing

Demonstrates the JFace 3.3 keyboard editing support for Trees without columns. Tabbing from editor to editor is supported since 3.4.

[edit] Snippet044NoColumnTableViewerKeyboardEditing

Demonstrates the JFace 3.3 keyboard editing support for Tables without columns. Tabbing from editor to editor is supported since 3.4.

[edit] Snippet045TableViewerFillFromBackgroundThread

Demonstrates how a TableViewer with a sorter can be filled from a NON-UI thread

[edit] Snippet046UpdateViewerFromBackgroundThread

Demonstrates how to update a viewer from a long running task (which is executed in a thread) and calls back to the UI-Thread using asyncExec

[edit] Snippet047VirtualLazyTreeViewer

Demonstrates the usage of ILazyContentProvider in conjunction with a Virtual-TreeViewer

[edit] Snippet048TreeViewerTabWithCheckboxFor3_3

Demonstrates how to overcome a limitation when it comes to key-navigation and CheckBoxEditors in 3.3.1.

[edit] Snippet049StyledCellLabelProvider

Demonstrates a new LabelProvider-Type which uses StyleRanges. This Snippet requires SWT/JFace 3.4.

Snippet050DelegatingStyledCellLabelProvider.gif

[edit] Snippet050DelegatingStyledCellLabelProvider

Demonstrates how you can add styled text by wrapping an existing label provider. This Snippet requires SWT/JFace 3.4.

[edit] Snippet051TableCenteredImage

Demonstrate how to center an image using owner draw. This snippet requires SWT/JFace 3.3.

[edit] Snippet052DouleClickCellEditor

Demonstrate how to start cell-editors on double click. This snippet requires SWT/JFace 3.3

[edit] Snippet053StartEditorWithContextMenu

Demonstrate how to start up an editor with a context menu and not with mouse clicking on the cell.

[edit] Snippet055HideShowColumn

Demonstrate hiding and showing columns

[edit] Snippet056BooleanCellEditor

Demonstrate a custom cell-editor which uses a real Checkbox-Button

[edit] Snippet057TableViewerSkipHiddenCells

Example of showing how easy cell-navigation with hidden cells is in 3.4

[edit] Snippet058CellNavigationIn34

Example for full feature cell navigation until bug 230955 is fixed


[edit] Snippet060TextCellEditorWithContentProposal

Show how to use content-proposal inside a CellEditor

[edit] Snippet061FakedNativeCellEditor

Full featured native looking viewer with checkboxes in an arbitary column

[edit] Snippet062TextAndDialogCellEditor

Demonstrates usage of TextAndDialogCellEditor. The email column uses the TextAndDialogCellEditor; othe columns use ordinary TextCellEditor.

[edit] Snippet063ComboViewer

Show how to use ComboViewer and set a inital selection

[edit] Window

[edit] Snippet020CustomizedControlTooltips

Demonstrates usage of new JFace 3.3 to show really cool ToolTips for your controls

[edit] Snippet031TableStaticTooltip

Demonstrates creation of ToolTips for Tables without using the JFace-Viewers API but only JFace-Tooltips

[edit] Wizard

[edit] Snippet047WizardWithLongRunningOperation

Demonstrates how to work with JFace-Wizards and fill a TableViewer from a Background-Thread without blocking the UI showing a progress bar in the meanwhile