PrF UG forms custom instancerow - Revision history

RichMorin at 00:53, November 14, 2008

2008-11-14T00:53:09Z

RichMorin: /* Customizing an InstanceRowWidget or InstanceTableWidget */

2008-10-26T23:42:07Z

‎Customizing an InstanceRowWidget or InstanceTableWidget

RichMorin: /* Warnings and Suggestions */

2008-10-21T21:51:54Z

‎Warnings and Suggestions

RichMorin at 21:51, October 21, 2008

2008-10-21T21:51:11Z

RichMorin at 22:14, October 15, 2008

2008-10-15T22:14:04Z

Show changes

RichMorin at 22:45, October 14, 2008

2008-10-14T22:45:52Z

RichMorin at 22:45, October 14, 2008

2008-10-14T22:45:32Z

RichMorin: Automated import of articles

2008-10-09T08:48:38Z

Automated import of articles

New page

__NOTOC__
== Customizing an InstanceRowWidget or InstanceTableWidget ==

{{PrF_UG_TOC_forms}}<div id='prf_ug'>

InstanceRowWidget
(Single Cardinality)
and InstanceTableWidget
(Multiple Cardinality)
show all the slot values for any instance that is a value of the slot.

<div>[[Image:PrF_UG_forms_instancerowwidget.png|forms_instancerowwidget]]</div>

You can perform the standard customizations:

<ul class='a'>
<li>
[[PrF_UG_forms_select_widget_type|Change the widget type]]
of an Instance field to an InstanceRowWidget or InstanceTableWidget using the
[[PrF_UG_forms_widget_type_menu|Widget Type Menu]].


<li>
[[PrF_UG_forms_modifying_controls_appearance|Resize or move]]
the widget using click and drag.


<li>
Change
[[PrF_UG_forms_change_widget_config#Changing_General_Properties|General]]
properties and/or select
[[PrF_UG_forms_change_widget_config#Choosing_a_Widget_s_Buttons|Action Buttons]],
using the
[[PrF_UG_forms_widget_configuration|Configure Widget]]
dialog box;
see
[[PrF_UG_forms_change_widget_config|Changing Widget Configuration Properties]]
for more information.

</ul>

The
[[PrF_UG_forms_widget_configuration|Configure Widget]]
dialog box for an InstanceRowWidget or InstanceTableWidget has the following additional customizations:

<ul class='a'>
<li>
[[#Defining_Columns|Defining Columns]]:
allows you to choose which slots to display and the order in which they are displayed.


<li>
[[#New_Instances|New Instances]]:
controls what happens when a user creates a new instance from this field.


<li>
[[#In-Place_Editing_Characteristics|In-place editing characteristics]]:
allows you to choose how the subinstances can be edited.


<li>
[[#Warnings_and_Suggestions|Warnings and Suggestions]]:
gives warnings if the widget is incorrectly configured

</ul>

=== Defining Columns ===

You can choose which slots to show in the widget and/or change the order in which they appear using the Define columns of instance table tab.
Although the current implementation does not allow you to change the order directly by dragging,
you can reorder the slots by first removing them from the widget,
and then adding them back in the order in which you wish them to appear.

To add or remove slots,
change their order,
or change the name under which they are displayed:

<ol class='a'>
<li>
Double-click on the widget to open the
[[PrF_UG_forms_widget_configuration|Configure Widget]]
dialog box.


<li>
Click the Define columns of instance table tab.

 <div>[[Image:PrF_UG_forms_instancetable_definecolumns.png|forms_instancetable_definecolumns]]</div>


<li>
To make any modifications,
you must click in the Column Name of the slot you wish to modify. (The top row,
Slot Name,
is a property of the slot and cannot be modified.)


<li>
To remove a column,
click in its Column Name and click the Remove the currently selected column
[[Image:PrF_UG_all_object.remove.gif|all_object.remove]]
button.


<li>
To rename a column,
edit the text in Column Name.


<li>
To add a column,
click the Add one or more slots to the list of columns
[[Image:PrF_UG_all_object.add.gif|all_object.add]]
button.
The column will be added after all the existing columns.


<li>
To reorder columns,
remove all the columns except the one you want to appear first,
then add the other columns.
For instance,
to make date appear first in the example,
you would delete the prototype,
contents,
and number_of_pages columns,
then add any columns you wanted back in.

</ol>

=== New Instances ===

If you are allowing end-users to create new instances from this field,
you can control various aspects of new instance creation. (If you do not want users to be able to create instances,
disable the Create Instance
<div>[[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]]</div>
button using the
[[PrF_UG_forms_change_widget_config#Choosing_a_Widget_s_Buttons|Buttons tab]].)

<ol class='a'>
<li>
Double-click on the widget to open the
[[PrF_UG_forms_widget_configuration|Configure Widget]]
dialog box.


<li>
Click the New instances tab.

 <div>[[Image:PrF_UG_forms_instancetable_newinstances.png|forms_instancetable_newinstances]]</div>


<li>
Select the basic options you want:


<ul>
<li>
Display forms for newly-created instances:
When enabled,
the Instance Editor is automatically displayed whenever the end-user creates a new instance.
This allows the user to define the properties of the instance immediately.
If this option is disabled,
you may want to enable Use in place editing at the In-place Editing Characteristics tab. (Users can still edit the instance by clicking the View Instance
[[Image:PrF_UG_inst_instance.view.gif|instances_instance.view]]
button.)


<li>
Automatically select newly created or added rows: When this option is enabled,
the row corresponding to the new instance is automatically selected;
again,
this is useful if you allow in-place editing.


<li>
Always highlight selected row:
This option is self-explanatory.

</ul>

<li>
Select the Prototype Depth to control how the values in this field are copied if the instance that contains this field is copied:


<ul>
<li>
Shallow Copy:
If the containing instance is copied,
the copy has the same instance(s) as values for this field that the original does.


<li>
Depth 1 Copy:
If the containing instance is copied,
the value(s) of this field will be shallow copies of the original instances in this field.
For example,
if this field contains three instances and the containing instance is copied,
the new instance will have three new instances at this field;
they will be identical to the previous instances except for the name.


<li>
Deep Copy:
New instances are created for each instance in the field and for any additional referenced instances.
See
[[PrF_UG_inst_copy_instance#What_is_a_Deep_Copy_|What is a Deep Copy?]]
for more information.

</ul>
</ol>

=== In-Place Editing Characteristics ===

<ol class='a'>
<li>
Double-click on the widget to open the
[[PrF_UG_forms_widget_configuration|Configure Widget]]
dialog box.


<li>
Click the In-place Editing Characteristics tab.

 <div>[[Image:PrF_UG_forms_instancetable_editing.png|forms_instancetable_editing]]</div>


<li>
Select the options you want:


<ul>
<li>
Use in place editing:
This allows the user to edit a value directly in the instance table.


<li>
Use a dialog panel to select classes:
If the instance values of the field have fields of type Class,
enabling this means that double-clicking in the field displays a menu which allows the user to select a class.


<li>
Use a dialog panel to select instances:
If the instance values of the field have fields of type Instance,
enabling this means that double-clicking in the field displays a menu which allows the user to select a class.
You may want to enable this if Display forms for newly-created instances is disabled at the New Instances tab.

</ul>
</ol>

==== Example: using the dialog panel to select instances ====

If Use a dialog panel to select instances is enabled,
then the user can select an instance as follows:

<ol class='a'>
<li>
Double-click in the instance field.
A menu is displayed:

 <div>[[Image:PrF_UG_forms_instancerow_inplace_choose.png|forms_instancerow_inplace_choose]]</div>


<li>
Select Choose... to open the Select Instance dialog box.

 <div>[[Image:PrF_UG_forms_select_instance.png|forms_select_instance]]</div>


<li>
Select the class and instance you want and click OK.

</ol>

If the field already contains a value,
the user can change it in the same manner:

<ol class='a'>
<li>
Double-click in the instance field.
A menu is displayed:

 <div>[[Image:PrF_UG_forms_instancerow_inplace_remove.png|forms_instancerow_inplace_remove]]</div>


<li>
Select Choose... to open the Select Instance dialog box.
You can also choose View... to display the Instance Editor for this instance,
or Remove to clear the field.


<li>
Select the class and instance you want and click OK.

</ol>

=== Warnings and Suggestions ===

You can check the configuration of the widget at the Warnings and Suggestions tab.

<div>[[Image:PrF_UG_forms_instancetable_warnings.png|forms_instancetable_warnings]]</div>

</div>

@@ Line 2: / Line 2: @@
 == Customizing an InstanceRowWidget or InstanceTableWidget ==
-{{PrF_UG_TOC_forms}}<div id='prf_ug'>
+<noinclude>{{PrF_UG_TOC_forms}}<div id='prf_ug'></noinclude>
 InstanceRowWidget (Single Cardinality)
@@ Line 281: / Line 281: @@
-</div>
+<noinclude></div></noinclude>

@@ Line 17: / Line 17: @@
      [[PrF_UG_forms_select_widget_type|Change the widget type]] of an Instance field
      to an InstanceRowWidget or InstanceTableWidget
-     using the [[PrF_UG_forms_widget_type_menu|Widget Type Menu]].
+     using the [[PrF_UG_forms_widget_type_menu|Widget Type menu]].
      </p>
@@ Line 43: / Line 43: @@
 You can choose which slots to show in the widget
-and/or change the order in which they appear using the <b>Define columns of instance table</b> tab.
+and/or change the order in which they appear
-Although the current implementation does not allow you to change the order directly by dragging,
+using the <b>Define columns of instance table</b> tab.
 you can reorder the slots by first removing them from the widget,
 and then adding them back in the order in which you wish them to appear.
@@ Line 276: / Line 278: @@
 <div>[[Image:PrF_UG_forms_instancetable_warnings.png|frame|none|
-           Configure Widget dialog, Warnings and Suggestions tab]]</div>
+       Configure Widget dialog, Warnings and Suggestions tab]]</div>
 </div>

@@ Line 277: / Line 277: @@
 <div>[[Image:PrF_UG_forms_instancetable_warnings.png|frame|none|
             Configure Widget dialog, Warnings and Suggestions tab]]</div>
 </div>

@@ Line 8: / Line 8: @@
 show all the slot values for any instance that is a value of the slot.
-<div>[[Image:PrF_UG_forms_instancerowwidget.png|forms_instancerowwidget]]</div>
+<div>[[Image:PrF_UG_forms_instancerowwidget.png|frame|none|
 You can perform the standard customizations:
@@ Line 59: / Line 60: @@
      Click the <b>Define columns of instance table</b> tab.
      </p>
-     <div>[[Image:PrF_UG_forms_instancetable_definecolumns.png|forms_instancetable_definecolumns]]</div>
+     <div>[[Image:PrF_UG_forms_instancetable_definecolumns.png|frame|none|
    <li><p>
@@ Line 70: / Line 72: @@
      To remove a column,
      click in its <b>Column Name</b> and click the <b>Remove the currently selected column</b>
-     [[Image:PrF_UG_all_object.remove.gif|all_object.remove]] button.
+     ([[Image:PrF_UG_all_object.remove.gif|all_object.remove]]) button.
      </p>
@@ Line 81: / Line 83: @@
      To add a column,
      click the <b>Add one or more slots to the list of columns</b>
-     [[Image:PrF_UG_all_object.add.gif|all_object.add]] button.
+     ([[Image:PrF_UG_all_object.add.gif|all_object.add]]) button.
      The column will be added after all the existing columns.
      </p>
@@ Line 100: / Line 102: @@
 If you are allowing end-users to create new instances from this field,
 you can control various aspects of new instance creation.
-(If you do not want users to be able to create instances,
+If you do not want users to be able to create instances,
 disable the <b>Create Instance</b>
-[[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]] button
+([[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]]) button
-using the [[PrF_UG_forms_change_widget_config#Choosing_a_Widget_s_Buttons|Buttons tab]].)
+using the [[PrF_UG_forms_change_widget_config#Choosing_a_Widget_s_Buttons|Buttons tab]].
 <ol class='a'>
@@ Line 114: / Line 116: @@
      Click the <b>New instances</b> tab.
      </p>
-     <div>[[Image:PrF_UG_forms_instancetable_newinstances.png|forms_instancetable_newinstances]]</div>
+     <div>[[Image:PrF_UG_forms_instancetable_newinstances.png|frame|none|
    <li><p>
@@ Line 130: / Line 133: @@
        you may want to enable <b>Use in place editing</b>
        at the <b>In-place Editing Characteristics</b> tab.
-       (Users can still edit the instance by clicking the <b>View Instance</b>
+       </p>
-       [[Image:PrF_UG_inst_instance.view.gif|instances_instance.view]] button.)
+      <p>
        </p>
@@ Line 188: / Line 194: @@
      Click the <b>In-place Editing Characteristics</b> tab.
      </p>
-     <div>[[Image:PrF_UG_forms_instancetable_editing.png|forms_instancetable_editing]]</div>
+     <div>[[Image:PrF_UG_forms_instancetable_editing.png|frame|none|
    <li><p>
@@ Line 228: / Line 235: @@
      A menu is displayed:
      </p>
-     <div>[[Image:PrF_UG_forms_instancerow_inplace_choose.png|forms_instancerow_inplace_choose]]</div>
+     <div>[[Image:PrF_UG_forms_instancerow_inplace_choose.png|frame|none|
    <li><p>
      Select <b>Choose...</b> to open the <b>Select Instance</b> dialog box.
      </p>
-     <div>[[Image:PrF_UG_forms_select_instance.png|forms_select_instance]]</div>
+     <div>[[Image:PrF_UG_forms_select_instance.png|frame|none|
    <li><p>
@@ Line 248: / Line 257: @@
      A menu is displayed:
      </p>
-     <div>[[Image:PrF_UG_forms_instancerow_inplace_remove.png|forms_instancerow_inplace_remove]]</div>
+     <div>[[Image:PrF_UG_forms_instancerow_inplace_remove.png|frame|none|
    <li><p>
@@ Line 265: / Line 275: @@
 You can check the configuration of the widget at the <b>Warnings and Suggestions</b> tab.
-<div>[[Image:PrF_UG_forms_instancetable_warnings.png|forms_instancetable_warnings]]</div>
+<div>[[Image:PrF_UG_forms_instancetable_warnings.png|frame|none|
 </div>

@@ Line 42: / Line 42: @@
 dialog box for an InstanceRowWidget or InstanceTableWidget
 has the following additional customizations: Defining Columns, New Instances,
-In-place editing characteristics, Warnings and Suggestions]].
+In-place editing characteristics, Warnings and Suggestions.
 === Defining Columns ===