PrF UG forms custom contains - Revision history

RichMorin at 00:52, November 14, 2008

2008-11-14T00:52:46Z

RichMorin: /* Customizing a ContainsWidget */

2008-10-26T23:40:43Z

‎Customizing a ContainsWidget

RichMorin: /* Customizing a ContainsWidget */

2008-10-26T23:40:05Z

‎Customizing a ContainsWidget

RichMorin: /* Instance Creation */

2008-10-21T21:42:27Z

‎Instance Creation

RichMorin at 21:41, October 21, 2008

2008-10-21T21:41:45Z

RichMorin at 22:06, October 15, 2008

2008-10-15T22:06:35Z

Show changes

RichMorin at 22:43, October 14, 2008

2008-10-14T22:43:29Z

RichMorin at 22:42, October 14, 2008

2008-10-14T22:42:46Z

RichMorin: Automated import of articles

2008-10-09T08:48:24Z

Automated import of articles

New page

__NOTOC__
== Customizing a ContainsWidget ==

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

ContainsWidget is an optional widget for slots of type Instance.
It contains a version of the Instance Editor for each value of the slot.
ContainsWidget is useful primarily for Instance slots where the Editor for the Allowed Classes is fairly simple,
and where the cardinality is single or small.

For a widget that provides a summary of selected fields,
see
[[PrF_UG_forms_instancerow|InstanceRowWidget]]
or
[[PrF_UG_forms_instancerow|InstanceTableWidget]].

<div>[[Image:PrF_UG_forms_containswidget.png|forms_containswidget]]</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 ContainsWidget,
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 corresponding tab in 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 a ContainsWidget has the following additional customizations:

<ul class='a'>
<li>
[[#Appearance|Appearance]]:
allows you to choose how subwidgets are displayed.


<li>
[[#Instance_Creation|Instance Creation]]:
controls what happens when a user creates a new instance from this field.


<li>
[[#Summary_Panel|Summary Panel]]:
controls the text that appears in the Summary Panel at the top of the widget.

</ul>

=== Appearance ===

The Appearance tab allows you to control how the "subwidgets",
or Instance Editors,
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 Appearance tab.

 <div>[[Image:PrF_UG_forms_contains_appearance.png|forms_contains_appearance]]</div>


<li>
Select the options you want:


<ul>
<li>
Allow subordinate widgets to be selected:
allows the user to select and edit the Instance Editor(s) directly inside the widget.


<li>
Use separator between subwidgets:
places a horizontal line between subwidgets.


<li>
Space to put between subwidgets:
specifies the spacing,
in points.


<li>
Stack subwidgets vertically:
chooses between a vertical or horizontal display for the subwidgets.

</ul>
</ol>

=== Instance Creation ===

If you are allowing end-users to create new instances from this field,
you can control various aspects. (If you do not want users 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|Action 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 Instance Creation tab.

 <div>[[Image:PrF_UG_forms_contains_creation.png|forms_contains_creation]]</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.


<li>
Newly inserted instances are selected: When this option is enabled,
the form corresponding to the new instance is automatically selected.


<li>
Insert at point of current selection:
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>

=== Summary Panel ===

The Summary Panel is shown at the top of the widget.

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


<li>
Click the Summary Panel tab.

 <div>[[Image:PrF_UG_forms_contains_summary.png|forms_contains_summary]]</div>


<li>
Select the options you want:


<ul>
<li>
Display Summary Panel:
displays or hides the summary panel


<li>
Display Total Number of Subordinate Instances:
gives the number of instances in the field.


<li>
Display Browser Keys of Subordinate Instances:
in the current version,
this has no effect.

</ul>
</ol>

</div>

@@ Line 2: / Line 2: @@
 == Customizing a ContainsWidget ==
-{{PrF_UG_TOC_forms}}<div id='prf_ug'>
+<noinclude>{{PrF_UG_TOC_forms}}<div id='prf_ug'></noinclude>
 ContainsWidget is an optional widget for slots of type Instance.
@@ Line 203: / Line 203: @@
-</div>
+<noinclude></div></noinclude>

@@ Line 105: / Line 105: @@
      Click the <b>Instance Creation</b> tab.
      </p>
-     <div>[[Image:PrF_UG_forms_contains_creation.png|fraame|none|
+     <div>[[Image:PrF_UG_forms_contains_creation.png|frame|none|
             Configure Widget dialog, Instance Creation tab]]</div>

@@ Line 14: / Line 14: @@
 or  [[PrF_UG_forms_instancerow|InstanceTableWidget]].
-<div>[[Image:PrF_UG_forms_containswidget.png|forms_containswidget]]</div>
+<div>[[Image:PrF_UG_forms_containswidget.png|frame|none|
 You can perform the standard customizations:
@@ Line 57: / Line 58: @@
      Click the <b>Appearance</b> tab.
      </p>
-     <div>[[Image:PrF_UG_forms_contains_appearance.png|forms_contains_appearance]]</div>
+     <div>[[Image:PrF_UG_forms_contains_appearance.png|frame|none|
    <li><p>
@@ Line 89: / Line 91: @@
 If you are allowing end-users to create new instances from this field,
-you can control various aspects. (If you do not want users to create instances,
+you can control various aspects.
-disable the <b>Create Instance</b>
+If you do not want users 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|Action Buttons tab]].)
+using the [[PrF_UG_forms_change_widget_config#Choosing_a_Widget_s_Buttons|Action Buttons tab]].
 <ol class='a'>
@@ Line 103: / Line 105: @@
      Click the <b>Instance Creation</b> tab.
      </p>
-     <div>[[Image:PrF_UG_forms_contains_creation.png|forms_contains_creation]]</div>
+     <div>[[Image:PrF_UG_forms_contains_creation.png|fraame|none|
    <li><p>
@@ Line 153: / Line 156: @@
      <li><p>
        <b>Deep Copy</b>:
-       New instances are created for each instance in the field <i>and</i> for any additional referenced instances.
+       New instances are created for each instance in the field
-       See [[PrF_UG_inst_copy_instance#What_is_a_Deep_Copy_|What is a Deep Copy?]] for more information.
+      <i>and</i> for any additional referenced instances.
        </p>
    </ul>
@@ Line 172: / Line 177: @@
      Click the <b>Summary Panel</b> tab.
      </p>
-     <div>[[Image:PrF_UG_forms_contains_summary.png|forms_contains_summary]]</div>
+     <div>[[Image:PrF_UG_forms_contains_summary.png|frame|none|
    <li><p>

@@ Line 33: / Line 33: @@
    <li><p>
      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]],
+     and/or select [[PrF_UG_forms_change_widget_config#Choosing_a_Widget_s_Buttons|Action Buttons]],
      using the corresponding tab in the [[PrF_UG_forms_widget_configuration|Configure Widget]] dialog box;
      see [[PrF_UG_forms_change_widget_config|Changing Widget Configuration Properties]]

@@ Line 10: / Line 10: @@
 For a widget that provides a summary of selected fields,
-see
+see [[PrF_UG_forms_instancerow|InstanceRowWidget]]
-[[PrF_UG_forms_instancerow|InstanceRowWidget]]
+or  [[PrF_UG_forms_instancerow|InstanceTableWidget]].
 <div>[[Image:PrF_UG_forms_containswidget.png|forms_containswidget]]</div>
@@ Line 47: / Line 45: @@
 </ul>
-The
+The [[PrF_UG_forms_widget_configuration|Configure Widget]]
 dialog box for a ContainsWidget has the following additional customizations:
 Appearance, Instance Creation, and Summary Panel.