Difference between revisions of "InstanceGridWidget"

From Protege Wiki

Jump to: navigation, search
(The field_type parameter: Updated table)
(The field_type parameter: Updated table)
Line 4: Line 4:
  
 
== The <code>field_type</code> parameter ==
 
== The <code>field_type</code> parameter ==
The <code>field_type</code> parameter sets the "type" of a field (i.e. a data cell) in the grid.<BR>
+
The <code>field_type</code> parameter sets the "type" of a field (i.e. data cell) in the grid.<BR>
To clearly separate the content of the field from it presentation, and the way these values are edited, we have created separate parameters (<code>field_value_type</code> and <code>field_editor</code>) to control those other aspects.
+
To clearly separate the content of the field from its presentation, and the way these values are edited, we have created separate parameters (<code>field_value_type</code> and <code>field_editor</code>) to control those other aspects of the field.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 14: Line 14:
 
|-
 
|-
 
|<code>linkicon</code>
 
|<code>linkicon</code>
|a link icon that provides a hyperlink to the URL represented by this cell's value
+
|shows a link icon, which provides a hyperlink to the URL represented by this property value
 
|-
 
|-
 
|<code>nolink</code>
 
|<code>nolink</code>
Line 20: Line 20:
 
|-
 
|-
 
|<code>checkbox</code>
 
|<code>checkbox</code>
|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.
+
|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").<BR>
 +
Unknown values are represented with a checkbox containing a red question mark.
 
|-
 
|-
 
|<code>checkbox_important</code>
 
|<code>checkbox_important</code>
|uses a three-way checkbox to represent "Not allowed"-"Allowed"-"Required" states, as 0-1-2 values. This is used by WHO, in the ICD-11 editor, iCAT.
+
|uses a three-way checkbox to represent "Not allowed"-"Allowed"-"Required" states, as 0-1-2 values.<BR>
 +
This field type was introduced to support use cases provided by WHO, and is used in the ICD-11 editor, iCAT.
 
|-
 
|-
 
|<code>radio</code>
 
|<code>radio</code>
|a radio button can represent true and false states for a number of items, with the restriction that always there is only one item is selected as true at a time.
+
|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".
 
|-
 
|-
 
|<code>combobox</code>
 
|<code>combobox</code>
|
+
|a dropdown list of elements that can be selected as the value of the property
 
|-
 
|-
 
|<code>class_browsertext</code>
 
|<code>class_browsertext</code>
|
+
|shows the "browser text" of the class that is set to be as the value of the property<BR>
 +
This is the default <code>field_type</code> for "Class" and "Cls" <code>field_value_type</code>s.
 
|-
 
|-
 
|<code>instance_browsertext</code>
 
|<code>instance_browsertext</code>
|
+
|shows the "browser text" of the instance that is set to be as the value of the property<BR>
|-
+
This is the default <code>field_type</code> for "Instance" the <code>field_value_type</code>.
 +
|-  
 
|<code>instance_property</code>
 
|<code>instance_property</code>
|
+
|shows the a given property value of the instance that is set to be as the value of the property.
 
|}
 
|}
  

Revision as of 23:00, December 5, 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.

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.

field_type
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 field_type for "Class" and "Cls" field_value_types.

instance_browsertext shows the "browser text" of the instance that is set to be as the value of the property

This is the default field_type for "Instance" the field_value_type.

instance_property shows the a given property value of the instance that is set to be as the value of the property.


field_value_type
value meaning
ligh_green light green


field_editor
value meaning
ligh_green light green


field_align
value meaning
ligh_green light green


field_bg_color
value meaning
ligh_green light green



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.

Personal tools