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 "Scout/Concepts/LookupRow"

m (Category changed)
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{ScoutPage|cat=Concepts}}
+
{{ScoutPage|cat=Shared}}
  
 
LookupRow is an entity keeping together some properties (key, text, color…) corresponding to one possible result for one {{ScoutLink|Concepts|LookupCall|LookupCall}}.
 
LookupRow is an entity keeping together some properties (key, text, color…) corresponding to one possible result for one {{ScoutLink|Concepts|LookupCall|LookupCall}}.
Line 6: Line 6:
  
 
== Description ==
 
== Description ==
{{note|TODO|Add a description}}
+
A LookupCall is responsible to compute a set of LookupRows depending on an input. If many rows are returned by the LookupCall, a SmartField will display them. That way the user can choose one of them.
  
 +
[[Image:Schema_LookupRow.png]]
  
== Properties ==
+
===Content of a LookupRow===
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
+
The Lookup Call contains:
 
+
* key
{{note|TODO|Add a description of important properties. The idea is not to recreate the JavaDoc of the getConfiguredXxxxxx() methods but to provide explanations, best practice, example... Group the properties by domain.}}
+
* text
 +
* iconId
 +
* tooltip
 +
* background color
 +
* foreground color
 +
* font
 +
* enabled
 +
* parentKey
 +
* active
  
 +
== Code example ==
 +
{{note|TODO|Different Constructors. Convience Method to create the lookup rows }}
  
 
== See Also ==
 
== See Also ==

Revision as of 12:19, 3 November 2011

The Scout documentation has been moved to https://eclipsescout.github.io/.

LookupRow is an entity keeping together some properties (key, text, color…) corresponding to one possible result for one The Scout documentation has been moved to https://eclipsescout.github.io/..

Description

A LookupCall is responsible to compute a set of LookupRows depending on an input. If many rows are returned by the LookupCall, a SmartField will display them. That way the user can choose one of them.

Schema LookupRow.png

Content of a LookupRow

The Lookup Call contains:

  • key
  • text
  • iconId
  • tooltip
  • background color
  • foreground color
  • font
  • enabled
  • parentKey
  • active

Code example

Note.png
TODO
Different Constructors. Convience Method to create the lookup rows


See Also

Back to the top