Category:Listing

From JRapid

Listings are the way of showing the existing instances of an entity in the database. They provide access to the whole dataset also allowing filtering, ordering and action execution on each instance.

You can add new listings to an entity to create diferents views for the instances of that entity. Each entity has an auto-generated listing and you can specify a defaultlisting attribute to an entity which is the default listing for that entity.

Once you create a listing in a entity you can embedd that listing in other entity.

Contents 1 Example: 2 Structure of a listing: 3 Usage: 4 Different views for a listing: 5 See also: 6 Example: 7 Structure of a listing: 8 Usage: 9 Different views for a listing: 10 See also:

Example:

The JRapid Code Generator generats for each entity a listing which shows al instances stored in the databse.

Structure of a listing:

Listings are composed visually by 3 sections: filters, view and actionbar.

1. filters section contains all the specified filters, and is by default placed on top of the view.
2. view section displays results in a certain way. The default view is called table: results are shown as a double entry table, with the defined properties as columns. Each row is a valid result of the query.
3. actionbar section includes paging toolbar, custom actions and system default actions (which are the add action and the remove action).

Both the filters and the actionbar sections modify the results shown in the view actionbar, as they define user parameters that restrict the query. These parameters could be filter definitions, a page selection (e.g., results from the 51st to the 100th) or just the addition or removal of an existing record. Defining a new listing view is just replacing the view section with a custom one, where results are presented in a specific way.

You can add a subset to a listing to filter it's results.

Usage:

 <listing
           name = NAME
           layout = "simple | left"
           view = "thumbnail | table | icons | basic"
           subset = SUBSET_NAME 
           displayproperties = COMMA_SEPARATED properties
           displayfilters = filter1, filter2 >
 
        [ Contents: tab* ]
 </listing>

1. name: name that uniquely identifies the listing inside each listing.
2. layout: indicates how to display filters, views, and actions.
3. view: indicates how to display the listings (icons, tables, images, etc.).
4. subset: indicates a subset for the information displayed in this listing.
5. displayproperties: defines the properties that will be displayed.
6. displayfilters: defines the filters that will be displayed.

A listing may be set based on a subset:

 <entity name="Pet">
   ...
   <listing name="thumbCats" subset="cats" view="thumbnail" />
   ...
 </entity>

The defaultlisting entity attribute may be used to define the default listing.

<entity ...  defaultlisting = LISTING_NAME ... />

Different views for a listing:

JRapid offers the possibility of displaying listings with different views.

See also:

• 

Listings are the way of showing the existing instances of an entity in the database. They provide access to the whole dataset also allowing filtering, ordering and action execution on each instance.

You can add new listings to an entity to create diferents views for the instances of that entity. Each entity has an auto-generated listing and you can specify a defaultlisting attribute to an entity which is the default listing for that entity.

Once you create a listing in a entity you can embedd that listing in other entity.

Example:

The JRapid Code Generator generats for each entity a listing which shows al instances stored in the databse.

Structure of a listing:

Listings are composed visually by 3 sections: filters, view and actionbar.

1. filters section contains all the specified filters, and is by default placed on top of the view.
2. view section displays results in a certain way. The default view is called table: results are shown as a double entry table, with the defined properties as columns. Each row is a valid result of the query.
3. actionbar section includes paging toolbar, custom actions and system default actions (which are the add action and the remove action).

Both the filters and the actionbar sections modify the results shown in the view actionbar, as they define user parameters that restrict the query. These parameters could be filter definitions, a page selection (e.g., results from the 51st to the 100th) or just the addition or removal of an existing record. Defining a new listing view is just replacing the view section with a custom one, where results are presented in a specific way.

You can add a subset to a listing to filter it's results.

Usage:

 <listing
           name = NAME
           layout = "simple | left"
           view = "thumbnail | table | icons | basic"
           subset = SUBSET_NAME 
           displayproperties = COMMA_SEPARATED properties
           displayfilters = filter1, filter2 >
 
        [ Contents: tab* ]
 </listing>

1. name: name that uniquely identifies the listing inside each listing.
2. layout: indicates how to display filters, views, and actions.
3. view: indicates how to display the listings (icons, tables, images, etc.).
4. subset: indicates a subset for the information displayed in this listing.
5. displayproperties: defines the properties that will be displayed.
6. displayfilters: defines the filters that will be displayed.

A listing may be set based on a subset:

 <entity name="Pet">
   ...
   <listing name="thumbCats" subset="cats" view="thumbnail" />
   ...
 </entity>

The defaultlisting entity attribute may be used to define the default listing.

<entity ...  defaultlisting = LISTING_NAME ... />

Different views for a listing:

JRapid offers the possibility of displaying listings with different views.

See also:

• Subset