InstanceGridWidget - Revision history

Csnyulas: /* The field_type parameter */ Changed instance_property to instance_property_value

2017-03-01T23:41:25Z

‎The field_type parameter: Changed instance_property to instance_property_value

Csnyulas: /* The field_type parameter */ Added instance_property_icon

2017-03-01T23:25:00Z

‎The field_type parameter: Added instance_property_icon

Csnyulas: Made all parameter values monospaced (with the `style)`


2016-12-13T07:41:02Z
Made all parameter values monospaced (with the <code> style)

				
				
				
				
				
				← Older revision
				Revision as of 07:41, December 13, 2016
				
Line 55:
Line 55:
  !meaning   !meaning
  |-   |-
− |String + |<code>String</code>
  |   |
  |-   |-
− |Symbol + |<code>Symbol</code>
  |   |
  |-   |-
− |Literal + |<code>Literal</code>
  |   |
  |-   |-
− |Integer + |<code>Integer</code>
  |   |
  |-   |-
− |Float + |<code>Float</code>
  |   |
  |-   |-
− |Date + |<code>Date</code>
  |   |
  |-   |-
− |Boolean + |<code>Boolean</code>
  |   |
  |-   |-
− |Instance + |<code>Instance</code>
  |   |
  |-   |-
− |Cls + |<code>Cls</code>
  |   |
  |-   |-
− |Class + |<code>Class</code>
  |   |
  |-   |-
− |Property + |<code>Property</code>
  |   |
  |-   |-
− |Any + |<code>Any</code>
  |   |
  |}   |}
Line 107:
Line 107:
  !meaning   !meaning
  |-   |-
− |inline + |<code>inline</code>
  |editing happens right within the grid cell, as the label used to display the value of the field turns into an editable textfield.   |editing happens right within the grid cell, as the label used to display the value of the field turns into an editable textfield.
  |-   |-
− |flexible + |<code>flexible</code>
  |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 into a textfield.<BR>   |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 into a textfield.<BR>
  This is the default for all <code>String</code> valued <code>field_value_type</code>s.   This is the default for all <code>String</code> valued <code>field_value_type</code>s.
  |-   |-
− |multiline + |<code>multiline</code>
  |the cell value will be edited in a separate pop-up window, presenting a multi-line text area editor.   |the cell value will be edited in a separate pop-up window, presenting a multi-line text area editor.
  |-   |-
− |html + |<code>html</code>
  |the cell value will be edited in a separate pop-up window, presenting a multi-line HTML editor.   |the cell value will be edited in a separate pop-up window, presenting a multi-line HTML editor.
  |-   |-
− |class_selector + |<code>class_selector</code>
  |the cell value will be edited in a separate pop-up window, where the user is presented with the class hierarchy of (a branch from) the ontology, from which he or she can choose one class.<BR>   |the cell value will be edited in a separate pop-up window, where the user is presented with the class hierarchy of (a branch from) the ontology, from which he or she can choose one class.<BR>
  This is the default for all <code>Class</code> valued <code>field_value_type</code>s.   This is the default for all <code>Class</code> valued <code>field_value_type</code>s.
  |-   |-
− |instance_selector + |<code>instance_selector</code>
  |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.<BR>   |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.<BR>
  This is the default for all <code>Instance</code> valued <code>field_value_type</code>s.   This is the default for all <code>Instance</code> valued <code>field_value_type</code>s.
Line 137:
Line 137:
  !meaning   !meaning
  |-   |-
− |left + |<code>left</code>
  |field content is left aligned. Default, if no value is specified.   |field content is left aligned. Default, if no value is specified.
  |-   |-
− |center + |<code>center</code>
  |field content is center aligned   |field content is center aligned
  |-   |-
− |right + |<code>right</code>
  |field content is right aligned   |field content is right aligned
  |}   |}
Line 158:
Line 158:
  !meaning   !meaning
  |-   |-
− |yellow + |<code>yellow</code>
  |yellow (#FFFF00) &nbsp;<span style="background-color:#FFFF00; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>   |yellow (#FFFF00) &nbsp;<span style="background-color:#FFFF00; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |-   |-
− |beige + |<code>beige</code>
  |beige (#F5F5DC) &nbsp;<span style="background-color:beige; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>   |beige (#F5F5DC) &nbsp;<span style="background-color:beige; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |-   |-
− |lightgreen + |<code>lightgreen</code>
  |light green (#90EE90) &nbsp;<span style="background-color:lightgreen; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>   |light green (#90EE90) &nbsp;<span style="background-color:lightgreen; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |-   |-
− |#4CAF50 + |<code>#4CAF50</code>
  |#4CAF50 &nbsp;<span style="background-color:#4CAF50; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>   |#4CAF50 &nbsp;<span style="background-color:#4CAF50; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |}   |}



Csnyulas: /* The field_bg_color parameter */ Added border around background preview areas. Created a separate section for concluding information.
2016-12-13T06:28:18Z
‎The field_bg_color parameter:  Added border around background preview areas. Created a separate section for concluding information.

				
				
				
				
				
				← Older revision
				Revision as of 06:28, December 13, 2016
				
Line 159:
Line 159:
  |-   |-
  |yellow   |yellow
− |yellow (#FFFF00) &nbsp;<span style="background-color:#FFFF00">&nbsp;&nbsp;&nbsp;&nbsp;</span> + |yellow (#FFFF00) &nbsp;<span style="background-color:#FFFF00; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |-   |-
  |beige   |beige
− |beige (#F5F5DC) &nbsp;<span style="background-color:beige; display:inline;">&nbsp;&nbsp;&nbsp;&nbsp;</span> + |beige (#F5F5DC) &nbsp;<span style="background-color:beige; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |-   |-
  |lightgreen   |lightgreen
− |light green (#90EE90) &nbsp;<span style="background-color:lightgreen;">&nbsp;&nbsp;&nbsp;&nbsp;</span> + |light green (#90EE90) &nbsp;<span style="background-color:lightgreen; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |-   |-
  |#4CAF50   |#4CAF50
− |#4CAF50 &nbsp;<span style="background-color:#4CAF50">&nbsp;&nbsp;&nbsp;&nbsp;</span> + |#4CAF50 &nbsp;<span style="background-color:#4CAF50; border:1px solid;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |}   |}
    
    
    
−   + == More information ==
    
  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 [http://smi-protege.stanford.edu/svn/icat/trunk/src/edu/stanford/bmir/protege/web/client/ui/portlet/propertyForm/FormConstants.java?view=markup edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.FormConstants] class.   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 [http://smi-protege.stanford.edu/svn/icat/trunk/src/edu/stanford/bmir/protege/web/client/ui/portlet/propertyForm/FormConstants.java?view=markup edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.FormConstants] class.



Csnyulas: /* The field_editor parameter */ Fixed minor formatting issues.
2016-12-13T01:44:07Z
‎The field_editor parameter:  Fixed minor formatting issues.

				
				
				
				
				
				← Older revision
				Revision as of 01:44, December 13, 2016
				
Line 111:
Line 111:
  |-   |-
  |flexible   |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. + |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 into a textfield.<BR>
  + This is the default for all <code>String</code> valued <code>field_value_type</code>s.
  |-   |-
  |multiline   |multiline
Line 120:
Line 121:
  |-   |-
  |class_selector   |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. + |the cell value will be edited in a separate pop-up window, where the user is presented with the class hierarchy of (a branch from) the ontology, from which he or she can choose one class.<BR>
  + This is the default for all <code>Class</code> valued <code>field_value_type</code>s.
  |-   |-
  |instance_selector   |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 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.<BR>
  + 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_align</code> parameter ==



Csnyulas: /* The field_bg_color parameter */ fixed color preview.
2016-12-13T01:37:44Z
‎The field_bg_color parameter:  fixed color preview.

				
				
				
				
				
				← Older revision
				Revision as of 01:37, December 13, 2016
				
Line 152:
Line 152:
  It can take any valid CSS color code or constant [http://www.w3schools.com/colors/colors_hex.asp]   It can take any valid CSS color code or constant [http://www.w3schools.com/colors/colors_hex.asp]
  {| class="wikitable"   {| class="wikitable"
− |+ Example <code>field_bg_color</code> value + |+ Example <code>field_bg_color</code> values
  |-   |-
  !value   !value
Line 158:
Line 158:
  |-   |-
  |yellow   |yellow
− |yellow (#FFFF00) <DIV style="background-color:#FFFF00">&nbsp;</DIV> + |yellow (#FFFF00) &nbsp;<span style="background-color:#FFFF00">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |-   |-
  |beige   |beige
− |beige (#F5F5DC) <DIV style="background-color:beige;">&nbsp;</DIV> + |beige (#F5F5DC) &nbsp;<span style="background-color:beige; display:inline;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |-   |-
  |lightgreen   |lightgreen
− |light green (#90EE90) <DIV style="background-color:lightgreen;">&nbsp;</DIV> + |light green (#90EE90) &nbsp;<span style="background-color:lightgreen;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |-   |-
  |#4CAF50   |#4CAF50
− |#4CAF50 <DIV style="background-color:#4CAF50">&nbsp;</DIV> + |#4CAF50 &nbsp;<span style="background-color:#4CAF50">&nbsp;&nbsp;&nbsp;&nbsp;</span>
  |}   |}
    



Csnyulas: Filled in information for field_editor, field_align and field_bg_color parameters
2016-12-13T01:21:19Z
Filled in information for field_editor, field_align and field_bg_color parameters

				
				
				
				
				
				← Older revision
				Revision as of 01:21, December 13, 2016
				
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
  |-   |-
− |ligh_green + |inline
− |light green + |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
  |-   |-
− |ligh_green + |left
− |light green + |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
  |-   |-
− |ligh_green + |yellow
− |light green + |yellow (#FFFF00) <DIV style="background-color:#FFFF00">&nbsp;</DIV>
  + |-
  + |beige
  + |beige (#F5F5DC) <DIV style="background-color:beige;">&nbsp;</DIV>
  + |-
  + |lightgreen
  + |light green (#90EE90) <DIV style="background-color:lightgreen;">&nbsp;</DIV>
  + |-
  + |#4CAF50
  + |#4CAF50 <DIV style="background-color:#4CAF50">&nbsp;</DIV>
  |}   |}
    



Csnyulas: /* The field_value_type parameter */ Clarified text.
2016-12-13T00:27:23Z
‎The field_value_type parameter:  Clarified text.

				
				
				
				
				
				← Older revision
				Revision as of 00:27, December 13, 2016
				
Line 94:
Line 94:
  For the more up-to-date list of possible values please see: [http://smi-protege.stanford.edu/svn/icat/trunk/src/edu/stanford/bmir/protege/web/client/rpc/data/ValueType.java?view=markup]<BR>   For the more up-to-date list of possible values please see: [http://smi-protege.stanford.edu/svn/icat/trunk/src/edu/stanford/bmir/protege/web/client/rpc/data/ValueType.java?view=markup]<BR>
  <BR>   <BR>
− Specifying this parameter is optional, as this information can be deduced from the ontology. However the type information sometimes is not calculated (and is not sent back and forth btw. the server and the client) in the code. In those cases the default value is assumed, namely <code>String</code>.<BR> + 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 <code>String</code>.<BR>
− The most interesting interesting use case for specifying this parameter is to override the default value, and specifying it would help choose the right defaults for the <code>field_type</code> and <code>field_editor</code> parameters. + 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 <code>field_type</code> and <code>field_editor</code> parameters.
    
    



Csnyulas: Updated info about the fied_value_type parameter
2016-12-08T07:37:10Z
Updated info about the fied_value_type parameter

				
				
				
				
				
				← Older revision
				Revision as of 07:37, December 8, 2016
				
Line 45:
Line 45:
  |}   |}
    
  + 
  + == The <code>field_value_type</code> parameter ==
  + The <code>field_value_type</code> parameter specifies the type of a field value in the grid.<BR>
    
  {| class="wikitable"   {| class="wikitable"
Line 52:
Line 55:
  !meaning   !meaning
  |-   |-
− |ligh_green + |String
− |light green + |
  + |-
  + |Symbol
  + |
  + |-
  + |Literal
  + |
  + |-
  + |Integer
  + |
  + |-
  + |Float
  + |
  + |-
  + |Date
  + |
  + |-
  + |Boolean
  + |
  + |-
  + |Instance
  + |
  + |-
  + |Cls
  + |
  + |-
  + |Class
  + |
  + |-
  + |Property
  + |
  + |-
  + |Any
  + |
  |}   |}
  + 
  + For the more up-to-date list of possible values please see: [http://smi-protege.stanford.edu/svn/icat/trunk/src/edu/stanford/bmir/protege/web/client/rpc/data/ValueType.java?view=markup]<BR>
  + <BR>
  + Specifying this parameter is optional, as this information can be deduced from the ontology. However the type information sometimes is not calculated (and is not sent back and forth btw. the server and the client) in the code. In those cases the default value is assumed, namely <code>String</code>.<BR>
  + The most interesting interesting use case for specifying this parameter is to override the default value, and specifying it would help choose the right defaults for the <code>field_type</code> and <code>field_editor</code> parameters.
    
    



Csnyulas: /* The field_type parameter */ Updated table
2016-12-06T06:00:57Z
‎The field_type parameter:  Updated table

				
				
				
				
				
				← Older revision
				Revision as of 06:00, December 6, 2016
				
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.
  |}   |}

InstanceGridWidget - Revision history

Csnyulas: /* The field_type parameter */ Changed instance_property to instance_property_value

Csnyulas: /* The field_type parameter */ Added instance_property_icon

Csnyulas: Made all parameter values monospaced (with the style)

Csnyulas: /* The field_bg_color parameter */ Added border around background preview areas. Created a separate section for concluding information.

Csnyulas: /* The field_editor parameter */ Fixed minor formatting issues.

Csnyulas: /* The field_bg_color parameter */ fixed color preview.

Csnyulas: Filled in information for field_editor, field_align and field_bg_color parameters

Csnyulas: /* The field_value_type parameter */ Clarified text.

Csnyulas: Updated info about the fied_value_type parameter

Csnyulas: /* The field_type parameter */ Updated table

Csnyulas: Made all parameter values monospaced (with the `style)`