Difference between revisions of "InstanceGridWidget"
m (→The field_value_type parameter: Clarified text.) |
(Filled in information for field_editor, field_align and field_bg_color parameters) |
||
| Line 98: | Line 98: | ||
| + | |||
| + | == The <code>field_editor</code> parameter == | ||
| + | The <code>field_editor</code> parameter specifies the editor that is used to edit the field value in the grid.<BR> | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ <code>field_editor</code> | |+ <code>field_editor</code> | ||
| Line 104: | Line 107: | ||
!meaning | !meaning | ||
|- | |- | ||
| − | | | + | |inline |
| − | | | + | |editing happens right within the grid cell, as the label used to display the value of the field turns into an editable textfield. |
| + | |- | ||
| + | |flexible | ||
| + | |editing happens right in the grid cell, as the label used to display the value in the cell turns either into an editable textarea (if there is enough vertical space for it) or to a textfield. This is the default for all <code>String</code> valued <code>field_value_type</code>s. | ||
| + | |- | ||
| + | |multiline | ||
| + | |the cell value will be edited in a separate pop-up window, presenting a multi-line text area editor. | ||
| + | |- | ||
| + | |html | ||
| + | |the cell value will be edited in a separate pop-up window, presenting a multi-line HTML editor. | ||
| + | |- | ||
| + | |class_selector | ||
| + | |the cell value will be edited in a separate pop-up window, where the user is presented with the class hierarchy (a branch from the ontology) from which he or she can choose on class. This is the default for all <code>Class</code> valued <code>field_value_type</code>s. | ||
| + | |- | ||
| + | |instance_selector | ||
| + | |the cell value will be edited in a separate pop-up window, where the user is presented with an instance list (which may be filtered by navigating a class hierarchy), from which he or she can choose on instance. This is the default for all <code>Instance</code> valued <code>field_value_type</code>s. | ||
|} | |} | ||
| + | |||
| + | == The <code>field_align</code> parameter == | ||
| + | The <code>field_editor</code> parameter specifies the editor that is used to edit the field value in the grid.<BR> | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ <code>field_align</code> | |+ <code>field_align</code> | ||
| Line 115: | Line 136: | ||
!meaning | !meaning | ||
|- | |- | ||
| − | | | + | |left |
| − | | | + | |field content is left aligned. Default, if no value is specified. |
| + | |- | ||
| + | |center | ||
| + | |field content is center aligned | ||
| + | |- | ||
| + | |right | ||
| + | |field content is right aligned | ||
|} | |} | ||
| + | |||
| + | == The <code>field_bg_color</code> parameter == | ||
| + | The <code>field_bg_color</code> parameter specifies the background color of a certain field in the grid.<BR> | ||
| + | It can take any valid CSS color code or constant [http://www.w3schools.com/colors/colors_hex.asp] | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | |+ <code>field_bg_color</code> | + | |+ Example <code>field_bg_color</code> value |
|- | |- | ||
!value | !value | ||
!meaning | !meaning | ||
|- | |- | ||
| − | | | + | |yellow |
| − | |light green | + | |yellow (#FFFF00) <DIV style="background-color:#FFFF00"> </DIV> |
| + | |- | ||
| + | |beige | ||
| + | |beige (#F5F5DC) <DIV style="background-color:beige;"> </DIV> | ||
| + | |- | ||
| + | |lightgreen | ||
| + | |light green (#90EE90) <DIV style="background-color:lightgreen;"> </DIV> | ||
| + | |- | ||
| + | |#4CAF50 | ||
| + | |#4CAF50 <DIV style="background-color:#4CAF50"> </DIV> | ||
|} | |} | ||
Revision as of 17:21, December 12, 2016
InstanceGridWidget Layout Configuration
This page provides a basic overview of the different configuration options that can be set in form of parameter-value pairs for the InstanceGridWidget (edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.InstanceGridWidget) in WebProtege.
Contents
The field_type parameter
The field_type parameter sets the "type" of a field (i.e. data cell) in the grid.
To clearly separate the content of the field from its presentation, and the way these values are edited, we have created separate parameters (field_value_type and field_editor) to control those other aspects of the field.
| value | meaning |
|---|---|
linkicon
|
shows a link icon, which provides a hyperlink to the URL represented by this property value |
nolink
|
displays a URL without creating a hyperlink to it (which would be the default behavior in the absence of this parameter specification) |
checkbox
|
shows a standard checkbox, where the checked checkbox represents the value "true" and the unchcheck checkbox represents the value false (or in case of non-boolean fields, any other value than "true"). Unknown values are represented with a checkbox containing a red question mark. |
checkbox_important
|
uses a three-way checkbox to represent "Not allowed"-"Allowed"-"Required" states, as 0-1-2 values. This field type was introduced to support use cases provided by WHO, and is used in the ICD-11 editor, iCAT. |
radio
|
a radio button can represent "true" and "false" states for a number of items, with the restriction that at any given time when an item is selected as "true" the other items will be set to "false". |
combobox
|
a dropdown list of elements that can be selected as the value of the property |
class_browsertext
|
shows the "browser text" of the class that is set to be as the value of the property This is the default |
instance_browsertext
|
shows the "browser text" of the instance that is set to be as the value of the property This is the default |
instance_property
|
shows the a given property value of the instance that is set to be as the value of the property. |
The field_value_type parameter
The field_value_type parameter specifies the type of a field value in the grid.
| value | meaning |
|---|---|
| String | |
| Symbol | |
| Literal | |
| Integer | |
| Float | |
| Date | |
| Boolean | |
| Instance | |
| Cls | |
| Class | |
| Property | |
| Any |
For the more up-to-date list of possible values please see: [1]
Specifying this parameter is optional, as this information can be deduced from the ontology. However, the type information is not always calculated in the code (and is not sent back and forth between the server and the client). In those cases the default value is assumed, namely String.
The most interesting use case for specifying this parameter is to override the default value, and specifying an explicit value for it would help WebProtege to choose the right defaults for the field_type and field_editor parameters.
The field_editor parameter
The field_editor parameter specifies the editor that is used to edit the field value in the grid.
| value | meaning |
|---|---|
| inline | editing happens right within the grid cell, as the label used to display the value of the field turns into an editable textfield. |
| flexible | editing happens right in the grid cell, as the label used to display the value in the cell turns either into an editable textarea (if there is enough vertical space for it) or to a textfield. This is the default for all String valued field_value_types.
|
| multiline | the cell value will be edited in a separate pop-up window, presenting a multi-line text area editor. |
| html | the cell value will be edited in a separate pop-up window, presenting a multi-line HTML editor. |
| class_selector | the cell value will be edited in a separate pop-up window, where the user is presented with the class hierarchy (a branch from the ontology) from which he or she can choose on class. This is the default for all Class valued field_value_types.
|
| instance_selector | the cell value will be edited in a separate pop-up window, where the user is presented with an instance list (which may be filtered by navigating a class hierarchy), from which he or she can choose on instance. This is the default for all Instance valued field_value_types.
|
The field_align parameter
The field_editor parameter specifies the editor that is used to edit the field value in the grid.
| value | meaning |
|---|---|
| left | field content is left aligned. Default, if no value is specified. |
| center | field content is center aligned |
| right | field content is right aligned |
The field_bg_color parameter
The field_bg_color parameter specifies the background color of a certain field in the grid.
It can take any valid CSS color code or constant [2]
| value | meaning |
|---|---|
| yellow | yellow (#FFFF00) |
| beige | beige (#F5F5DC) |
| lightgreen | light green (#90EE90) |
| #4CAF50 | #4CAF50 |
To get a more up-to-date list of all the supported parameters and values you may want to check out the latest version of the edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.FormConstants class.
