PropertyFormPortlet - Revision history

Csnyulas: /* Using grids (tables) */ Added link to InstanceGridWidget configuration page

2016-12-01T00:13:21Z

‎Using grids (tables): Added link to InstanceGridWidget configuration page

TaniaTudorache: /* Using grids (tables) */

2013-06-10T22:00:45Z

‎Using grids (tables)

TaniaTudorache at 21:58, June 10, 2013

2013-06-10T21:58:23Z

TaniaTudorache: /* Examples */

2013-06-10T21:22:15Z

‎Examples

Han at 13:47, June 24, 2011

2011-06-24T13:47:42Z

TaniaTudorache at 19:03, June 17, 2010

2010-06-17T19:03:15Z

Csnyulas: /* Examples of form editing widgets */

2010-06-16T07:11:10Z

‎Examples of form editing widgets

TaniaTudorache at 06:53, June 16, 2010

2010-06-16T06:53:23Z

TaniaTudorache at 06:49, June 16, 2010

2010-06-16T06:49:18Z

TaniaTudorache at 06:26, June 16, 2010

2010-06-16T06:26:09Z

← Older revision		Revision as of 00:13, December 1, 2016
Line 254:		Line 254:

	</pre>		</pre>
		+
		+	The list of possible configuration parameters for the <code>InstanceGridWidget</code> are documented [[InstanceGridWidget\|here]].

	= Examples =		= Examples =

@@ Line 135: / Line 135: @@
 <portlet>
 	<name>edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.PropertyFieldPortlet</name>
-    <height>200</height>
+        <height>200</height>
 	<width>0</width>
@@ Line 153: / Line 153: @@
 							<entry>
 								<string>name</string>
-								<string>contents</string>
+								<string>contents</string> <!-- Use fully qualified name for OWL properties -->
 							</entry>
 							<entry>
@@ Line 204: / Line 204: @@
 									<entry>
 										<string>property</string>
-										<string>headline</string>
+										<string>headline</string> <!-- use fully qualified name for OWL properties -->
 									</entry>
 									<entry>
@@ Line 225: / Line 225: @@
 									<entry>
 										<string>property</string>
-										<string>expiration_date</string>
+										<string>expiration_date</string> <!-- use fully qualified name for OWL properties -->
 									</entry>
 									<entry>
@@ Line 254: / Line 254: @@
 </pre>
 = Examples =

← Older revision		Revision as of 21:58, June 10, 2013
Line 122:		Line 122:

	More documentation about the properties of the widgets will be added as requested by the users.		More documentation about the properties of the widgets will be added as requested by the users.
		+
		+	= Using grids (tables) =
		+
		+	Here is a [http://smi-protege.stanford.edu/svn/icat/trunk/war/projectConfigurations/configuration_Collaborative%20Newspaper.xml?view=markup simple example] on how to configure the a grid widget. A grid widget is used for displaying instances (on rows) and their properties (on columns).
		+
		+	The grid is similar in functionality to the Protege 3.x [http://protegewiki.stanford.edu/wiki/PrF_UG_forms_custom_instancerow <code>InstanceTable</code>] slot widget. It should be used on properties that have as values one or multiple instances. Each row represents an instance value, and the configured columns show the properties of the instance value.
		+
		+	Below is an example from the Newspaper ontology:
		+
		+	<pre>
		+
		+	<portlet>
		+	<name>edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.PropertyFieldPortlet</name>
		+	<height>200</height>
		+	<width>0</width>
		+
		+	<properties>
		+	<entry>
		+	<string>tabs</string>
		+	<list>
		+	<map>
		+	<entry>
		+	<string>title</string>
		+	<string>Contents</string>
		+	</entry>
		+
		+	<entry>
		+	<string>contents</string>
		+	<map>
		+	<entry>
		+	<string>name</string>
		+	<string>contents</string>
		+	</entry>
		+	<entry>
		+	<string>label</string>
		+	<string>Contents</string>
		+	</entry>
		+	<entry>
		+	<string>tooltip</string>
		+	<string>The contents of the newspaper is modeled as a list of instances of class Content.</string>
		+	</entry>
		+	<entry>
		+	<string>help</string>
		+	<string>http://protege.stanford.edu/doc/users_guide/newspaper_example.html</string>
		+	</entry>
		+	<entry>
		+	<string>index</string>
		+	<string>1</string>
		+	</entry>
		+	<entry>
		+	<string>height</string>
		+	<string>200</string>
		+	</entry>
		+	<entry>
		+	<string>component_type</string>
		+	<string>grid</string>
		+	</entry>
		+	<entry>
		+	<string>show_add_existing</string>
		+	<boolean>true</boolean>
		+	</entry>
		+	<entry>
		+	<string>ont_type</string>
		+	<string>Content</string>
		+	</entry>
		+	<entry>
		+	<string>multiple_values_allowed</string>
		+	<boolean>true</boolean>
		+	</entry>
		+	<entry>
		+	<string>Column1</string>
		+	<map>
		+	<entry>
		+	<string>header</string>
		+	<string>Headline</string>
		+	</entry>
		+	<entry>
		+	<string>width</string>
		+	<string>all</string>
		+	</entry>
		+	<entry>
		+	<string>property</string>
		+	<string>headline</string>
		+	</entry>
		+	<entry>
		+	<string>index</string>
		+	<string>0</string>
		+	</entry>
		+	</map>
		+	</entry>
		+	<entry>
		+	<string>Column2</string>
		+	<map>
		+	<entry>
		+	<string>header</string>
		+	<string>Expiration date</string>
		+	</entry>
		+	<entry>
		+	<string>width</string>
		+	<string>100</string>
		+	</entry>
		+	<entry>
		+	<string>property</string>
		+	<string>expiration_date</string>
		+	</entry>
		+	<entry>
		+	<string>index</string>
		+	<string>1</string>
		+	</entry>
		+	<entry>
		+	<string>field_type</string>
		+	<string>combobox</string>
		+	</entry>
		+	<entry>
		+	<string>allowed_values</string>
		+	<list>
		+	<string>today</string>
		+	<string>tomorrow</string>
		+	</list>
		+	</entry>
		+	</map>
		+	</entry>
		+	</map>
		+	</entry>
		+
		+	</map>
		+	</list>
		+	</entry>
		+	</properties>
		+	</portlet>
		+
		+	</pre>

@@ Line 130: / Line 130: @@
 We have some example using this portlet here:
-http://smi-protege.stanford.edu/repos/protege/web-protege/branches/who/war/projectConfigurations/configuration_ICD.xml
+- [http://smi-protege.stanford.edu/svn/icat/trunk/war/projectConfigurations/configuration_Collaborative%20Newspaper.xml?view=markup Simple example] showing the use of the PropertyFormPortlet with the Newspaper example.
-http://smi-protege.stanford.edu/repos/protege/web-protege/branches/who/war/projectConfigurations/configuration_example_property_field_portlet.xml
 [[Category:WebProtege documentation]]

← Older revision		Revision as of 13:47, June 24, 2011
Line 132:		Line 132:
	http://smi-protege.stanford.edu/repos/protege/web-protege/branches/who/war/projectConfigurations/configuration_ICD.xml		http://smi-protege.stanford.edu/repos/protege/web-protege/branches/who/war/projectConfigurations/configuration_ICD.xml
	http://smi-protege.stanford.edu/repos/protege/web-protege/branches/who/war/projectConfigurations/configuration_example_property_field_portlet.xml		http://smi-protege.stanford.edu/repos/protege/web-protege/branches/who/war/projectConfigurations/configuration_example_property_field_portlet.xml
		+
		+	[[Category:WebProtege documentation]]

← Older revision		Revision as of 19:03, June 17, 2010
Line 4:		Line 4:
	__TOC__		__TOC__

		+	'''Learn more about how the layout configuration works in WebProtege by following this [[WebProtegeLayoutConfig\|tutorial]]'''.

	= Examples of form editing widgets =		= Examples of form editing widgets =

@@ Line 7: / Line 7: @@
 = Examples of form editing widgets =
-The <code>PropertyFieldPortlet</code> (<code>edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.PropertyFieldPortlet</code>) supports the '''form-based editing''' in WebProtege. The portlet allows the association of a property with an editing widget. There are different types of editing widgets: text field, text area, check box, radio box, combo box, html, instance table, etc. This feature is similar to the form-based editing support in Protege 3.x. The editing widgets can be organized in tab.
+The <code>PropertyFieldPortlet</code> (<code>edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.PropertyFieldPortlet</code>) supports the '''form-based editing''' in WebProtege. The portlet allows the association of a property with an editing widget. There are different types of editing widgets: text field, text area, check box, radio box, combo box, html, instance table, etc. This feature is similar to the form-based editing support in Protege 3.x. The editing widgets can be organized in tabs.
 An example of the ''PropertyFieldPortlet'' is shown below:
@@ Line 18: / Line 18: @@
 [[File:Editingwidgets.png]]
 = Types of property editing widgets =

@@ Line 116: / Line 116: @@
-The '''component_type''' is one of the types specified in the section above. The first entry in the property of the tabs (E.g. <code><string>http://www.w3.org/2000/01/rdf-schema#label</string>
+The '''component_type''' is one of the types specified in the section above. The first entry in the property of the tabs (E.g. <code><nowiki><string>http://www.w3.org/2000/01/rdf-schema#label</string>
-</code> is the property name to which the widget is associated. The '''name''' property must point to a unique name for the widget. The '''label''' property sets the display label in front of the widget. '''index''' specifies on what position in the tab should the widget be placed (0 - top, 1- below 0, etc.).
+</nowiki></code>) is the property name to which the widget is associated. The '''name''' property must point to a unique name for the widget. The '''label''' property sets the display label in front of the widget. '''index''' specifies on what position in the tab should the widget be placed (0 - top, 1- below 0, etc.).
 Different widgets have additional supported properties. Some of them support the '''read_only''' property, which can be used to make a widget read-only (in the first figure, ICD 10 code). The ''grid'' widget (a.k.a ''Instance Table Widget'') has properties for setting the columns in the table, their width, their type, etc.

@@ Line 39: / Line 39: @@
 * '''instancecheckbox''' - show as checkboxes an instance value set (multiple cardinality)
 * '''instanceradiobutton''' - show as radio box an instance value set (single cardinality)
 '''Note.''' The list of available widgets will be extended as needed. The name of the widgets might also change in future releases.
@@ Line 46: / Line 47: @@
 Unfortunately the only way to configure the widgets in a ''PropertyFieldPortlet'' is to edit the [[WebProtegeLayoutConfig|layout configuration XML file]]. We are working on creating a user interface that would simplify the configuration process. Until then, please bear with us.

← Older revision		Revision as of 06:26, June 16, 2010
Line 39:		Line 39:
	* '''instancecheckbox''' - show as checkboxes an instance value set (multiple cardinality)		* '''instancecheckbox''' - show as checkboxes an instance value set (multiple cardinality)
	* '''instanceradiobutton''' - show as radio box an instance value set (single cardinality)		* '''instanceradiobutton''' - show as radio box an instance value set (single cardinality)
		+
		+	'''Note.''' The list of available widgets will be extended as needed. The name of the widgets might also change in future releases.
		+
		+
		+	= Configuration of the property editing widgets =
		+
		+	Unfortunately the only way to configure the widgets in a ''PropertyFieldPortlet'' is to edit the [[WebProtegeLayoutConfig\|layout configuration XML file]]. We are working on creating a user interface that would simplify the configuration process. Until then, please bear with us.