Difference between revisions of "Riena/Snippets"

Revision as of 01:57, 26 February 2009

Riena Project > Riena Snippets

What are Snippets?

Riena Snippets are small stand-alone programs that demonstrate specific techniques or functionality. Often a small example is the easiest way to understand how to use a particular feature.

To run a snippet:

• create a new project that depends on org.eclipse.riena.client
• copy the desired snippet to the clipboard
• select your project and paste the snippet into your project. The snippet class will be created for you
• run by selecting the class and then selecting Run > Run As > Java Application

Note that the snippets are edited for brevity rather than completeness. They are intended to guide the reader towards the correct solution, rather than be finished products. They are tested against the HEAD stream and may sometimes reference new API or require bug fixes from there.

Snippets also help isolate problems. The best way to report an Riena bug is to write your own snippet showing the problem and paste it into the bug report. For a snippet template, see the "Hello World" example.

To contribute a new snippet, create a snippet contribution in Bugzilla. Thanks in advance for your contribution!

Snippets

HelloWorld

• Hello World

LabelRidget

• LabelRidget with text property bound to a changing model value (like a time)
• LabelRidget with icons
• LabelRidget with a tooltip

TextRidget

• TextRidget with minimum length validation rule and direct writing
• TextRidget with and without direct writing
• TextRidget with 'on edit' validation
• TextRidget with 'on update' validation
• TextRidget with mandatory marker (user input required)
• TextRidget with disabled marker
• TextRidget with error marker
• TextRidget with error marker and error message
• TextRidget with output marker (read only)
• Toggle visibility of a TextRidget
• TextRidget with conversion rule (IConverter)
• Blocked TextRidget
• Non-focusable TextRidget
• TextRidgets using a TooltipMessageMarkerViewer for showing error messages in their tooltip

NumericTextRidget

• Numeric text field ridget with 6 digit maximum number length rule

DecimalTextRidget

• Decimal text field ridget with 9 decimal digits, 4 fraction digits and optional sign prefix ('-')

DateTextRidget

• Date text field ridget width a 'dd.MM.yyyy' pattern.

SingleChoiceRidget / ChoiceComposite

Use this for 'radio' buttons.

• Binding a SingleChoiceRidget's input to a model
• Binding a SingleChoiceRidget's selection to a model
• SingleChoiceRidget with mandatory marker
• SingleChoiceRidget with output marker (read only)

MultipleChoiceRidget / ChoiceComposite

Use this for 'check' buttons.

• Binding a MultipleChoiceRidget's input to a model
• Binding a MultipleChoiceRidget's selection to a model
• SingleChoiceRidget with mandatory marker
• SingleChoiceRidget with output marker (read only)

ActionRidget

Use this for 'push' buttons.

• ActionRidget with an ActionListener
• ActionRidget with Text, Icon and an ActionListener

ToggleButtonRidget

Use this for 'toggle' buttons.

• ToggleButtonRidget with SWT.PUSH Button and an ActionListener
• ToggleButtonRidget with SWT.CHECK Button and an ActionListener (important: use SingleChoiceRidget for a group of check buttons)
• ToggleButtonRidget with SWT.RADIO Button and an ActionListener (important: this is supported but does not make sense, use MultipleChoiceRidget instead)
• ToggleButtonRidget with icon and text

ComboRidget

• Binding a ComboRidget's input to a model
• Binding a ComboRidget's selection to a model
• Designate a placeholder item, that is equivalent to no selection

ListRidget

• Binding a ListRidget's input to a model
• Binding a ListRidget's selection to a model
• A sorted ListRidget
• ListRidget with output marker (read only)

TableRidget

• Demonstrates binding a TableRidget to a model.

• Binding a TableRidget's selection to a model
• TableRidget with column headers
• TableRidget without column headers
• TableRidget with moveable columns (user can use drag&drop to reorder the columns)
• TableRidget with boolean value in one column (automatically shown as checkbox)
• TableRidget with double-click listener
• TableRidget that allows sorting.

• TableRidget with output marker (selection cannot be changed)
• TableRidget with a formatted date column (ColumnFormatter)

CompositeTableRidget

TreeRidget

• Demonstrates binding a TreeRidget to a TreeNode-based model

• Demonstrates binding a TreeRidget to a bean-based model
• Hiding the root element in a TreeRidget
• Changing the expanded / collapsed state of a TreeRidget
• TreeRidget with output marker (selection cannot be changed)
• Tie the visibility of a tree item to the value of a method
• Tie the enablement of a tree item to the value of a method

TreeTableRidget

A tree with columns. It can do everything TreeRidget can do and more.

• Demonstrates binding a TreeTableRidget to a bean-based model
• TreeTableRidget that allows sorting
• TreeTableRidget with grouping (toggling on and off)
• TreeTableRidget with output marker (selection cannot be changed)

ShellRidget

StatuslineRidget

StatuslineNumberRidget

MessageBoxRidget

Shows messages to the user in a popup window.

• Demonstrates the usage of a MessageBoxRidget

EmbeddedTitleBarRidget (?)

ModuleTitleBarRidget (?)

DialogView

Used to build dialogs that use the Riena concept of views and controllers.

• Demonstrates the usage of a DialogView

MasterDetailsRidget