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/LookupCall"

(Input)
Line 16: Line 16:
 
Lookup calls provide different method to compute the set of {{ScoutLink|Concepts|LookupRow|LookupRows}} :
 
Lookup calls provide different method to compute the set of {{ScoutLink|Concepts|LookupRow|LookupRows}} :
  
* <code>getDataByKey()</code> Retrieve a single lookup row for a specific key value. Used by SmartFields and SmatColumns to get the display text for a given key value.
+
* <code>getDataByKey()</code>: Retrieves a single lookup row for a specific key value. Used by SmartFields and SmatColumns to get the display text for a given key value.
* <code>getDataByText()</code>: Retrieve multiple lookup rows which match a certain String. Used by SmartFields when the user start to enter some text in the Field.
+
* <code>getDataByText()</code>: Retrieve multiple lookup rows which match a certain String. Used by SmartFields when the user starts to enter some text in the field.
* <code>getDataByAll()</code>: Retrieves all available lookup rows. Used by SmartFields when the user clic on the browse icon.
+
* <code>getDataByAll()</code>: Retrieves all available lookup rows. Used by SmartFields when the user clicks on the browse icon.
* <code>getDataByRec()</code>: This can only be used for hierarchical lookup calls. It retrieves all available sub-tree lookup rows for a given parent.  
+
* <code>getDataByRec()</code>: This can only be used for hierarchical lookup calls. It retrieves all available sub-tree lookup rows for a given parent.
  
 
{{note|TODO|parameters are present to compute the set of rows: Object key, ... Master}}
 
{{note|TODO|parameters are present to compute the set of rows: Object key, ... Master}}

Revision as of 10:56, 2 November 2011

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

Lookup calls are mainly used by The Scout documentation has been moved to https://eclipsescout.github.io/. and The Scout documentation has been moved to https://eclipsescout.github.io/. to look up single or multiple The Scout documentation has been moved to https://eclipsescout.github.io/..

Description

The Lookup call mechanism is used to lookup up a set of key-text pairs. Whereas the key can be of any Java type the text must be of the type String. Each entry in this set is called LookupRow. In addition to the key and the text a LookupRow can also define and icon, font, colors and a tooltiptext.

This schema explains the role of a LookupCall in a SmartField:

Schema LookupCall.png

Input

Lookup calls provide different method to compute the set of The Scout documentation has been moved to https://eclipsescout.github.io/. :

  • getDataByKey(): Retrieves a single lookup row for a specific key value. Used by SmartFields and SmatColumns to get the display text for a given key value.
  • getDataByText(): Retrieve multiple lookup rows which match a certain String. Used by SmartFields when the user starts to enter some text in the field.
  • getDataByAll(): Retrieves all available lookup rows. Used by SmartFields when the user clicks on the browse icon.
  • getDataByRec(): This can only be used for hierarchical lookup calls. It retrieves all available sub-tree lookup rows for a given parent.
Note.png
TODO
parameters are present to compute the set of rows: Object key, ... Master


Type of lookup calls

With a Lookup Service

Delegation to the The Scout documentation has been moved to https://eclipsescout.github.io/. on server side.

They are not necessarily restricted to a fix number of records. Instead they should be favoured if the set of records is rather large.

Directy

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

Note.png
TODO
Explain and mention the execCreateLookupRows method


An example of this approach is when a SmartField or a SmartColumn is configured to be use with a The Scout documentation has been moved to https://eclipsescout.github.io/.. A The Scout documentation has been moved to https://eclipsescout.github.io/. is instantiated for the CodeType. It creates the LookupRows corresponding to the The Scout documentation has been moved to https://eclipsescout.github.io/. in the CodeType.

Overview

LookupCall.png

Properties

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

Code example

Using a LookupCall in a SmartField

public class ColorSmartField extends AbstractSmartField<String> {
  // other configuration of properties.
  @Override
  protected Class<? extends LookupCall<?>> getConfiguredLookupCall(){
    return ColorLookupCall.class;
  }
}

Accessing a LookupRow directly

It is possible to access a LookupRow direclty. In this example the input is a key (thisKey) and the method getDataByKey() is used. Before accessing the text, we ensure that a LookupRow has been retrived.

//Execute the LookupCall (using DataByKey)
LookupCall call = new MyLookupCall();
call.setKey(thisKey);
LookupRow[] rows=call.getDataByKey();
 
//Get the text (with a null check)
String text = null;
if(rows != null && rows.length > 0) {
  text = rows[0].getText();
}

See Also

Back to the top