Difference between revisions of "Scout/Concepts/Column"

From Eclipsepedia

Jump to: navigation, search
Line 50: Line 50:
Defines that the column will contribute its text to the {{ScoutLink|Concepts|TablePage#Summary_Cell|summary cell}}.
Defines that the column will contribute its text to the {{ScoutLink|Concepts|Table#Summary_Cell|summary cell}}.

Latest revision as of 08:03, 8 February 2013

Wiki Home

Columns describe the structure of a Table

  • implements: I obj.pngIColumn<T>
  • extends: C obj.pngAbstractColumn<T>


[edit] Description

Add a description

A column is the entity of a table describing the structure of the data displayed in the table. Depending on the type of values contained in the column, one of the child implementation specialized for the given type should be considered.


[edit] Type of column

[edit] Accessing the values

Columns are typed. They allow getting the value they contain for a specific row. The getValue(row) is also typed:

  getTable().getNameColumn().getValue(row); //returns a String if NameColumn is a StringColumn.

This way is better than the un-typed getValue() proposed by the table row:

  row.getCell(getTable().getNameColumn()).getValue(); //returns Object

There are other convenience methods:

  • getSelectedValue() returning the value for column of the selected row
  • getSelectedValues() same function but useful if the table allows multiple rows selection.
  • getValues(rows) the function takes as input an array of rows and return their values.

[edit] Properties

Defined with getConfiguredXxxxxx() methods.

Displayable Only displayable columns can be displayed in the table. Not displayable columns are suitable for values that you need to have for each row (typically an unique id that you need to pass to a form that is opened when you edit the entity represented in the row).

Visible A column can be visible or not. The default behavior of a table lets the user configure the columns he want to display in a table.

Summary Defines that the column will contribute its text to the summary cell.

Primary TODO

Sorting properties

  • ... TODO
  • ...
  • ...
Link to the article How to sort Tables

[edit] Events

Defined with execXxxxxx() methods.

Add a description of important events. The idea is not to recreate the JavaDoc of the execXxxxxx() methods but to provide explanations, best practice, example... Group the events by domain.

[edit] See Also