Property views specify the property view JSP that renders a specific property in an item view. They also identify the mode and data type for that property. For example, a property view can specify a JSP fragment that is used to edit a string or view a boolean value. (It might be helpful to think of property views as property editors, although they can be used in modes other than editing.)
The property view defines an attribute map of values that are used in the JSP to control how the property is presented, for example by specifying the number of rows and columns to use to display a text area.
Tip: To find the JSP fragment that was used to render a specific property, display the page source and search for the label of the property you are interested in. Default views surround page fragments with comments such as the following:
<!-- Begin jsp URI /html/views/property/bigstring/htmlEdit.jsp -->
<!-- End jsp URI /html/views/property/bigstring/htmlEdit.jsp -->
The propertyView
item descriptor is defined as follows in ViewMapping.xml
:
<item-descriptor name="propertyView" display-property="name" query-cache-size="300"> <table name="vmap_pv" type="primary" id-column-name="id"> <property name="id" column-name="id" data-type="string"/> <property name="type" column-name="type" data-type="string"/> <property name="name" column-name="name" data-type="string"/> <property name="description" column-name="description" data-type="string"/> <property name="uri" column-name="uri" data-type="string"/> <property name="applicationName" column-name="app_name" data-type="string"/> <property name="isDefault" column-name="is_default" data-type="boolean"/> <property name="isReadOnly" column-name="is_readonly" data-type="boolean"/> <property name="isComponentPropertyView" column-name= "is_component" data-type="boolean"/> <property name="mode" column-name="mode_id" required="true" item-type="mapMode"/> </table> <!-- attributes property --> <table name="vmap_pv2pvad_rel" type="multi" id-column-name="view_id" multi-column-name="name"> <property name="attributes" component-item-type="propertyViewAttributeDefinition" column-name="attr_id" data-type="map" cascade="update,delete"/> </table> </item-descriptor>
propertyView
items have the following key properties:
Property | Use |
---|---|
| Name of the Web application where this view resides. The value is the display name defined for the application in its |
| Optional key/value pairs that define an attribute of this property view. For more information, see View Mapping Attributes. |
| Informational description of the property view. |
| Set to true if this is a view of a component property (component of a collection). |
| Set to true to use this view by default for this property in this mode. |
| Set to true to disallow editing of this view. |
| The map mode to use for this view. For more information, see Map Modes. This property is required. |
| The name for the view in the ACC. |
| The data type to which this view applies. |
| The URI of the JSP that renders this view. |
For example, the following table shows the WYSIWIG HTML Editor
propertyView
(the view for the HTML editor used by default in the ATG Business Control Center to edit big string
properties):
Property | Value |
---|---|
| Publishing Portlets |
| (various key/value pairs that define aspects of this property editor; see the example that follows) |
| WYSIWYG HTML editor for big string properties |
| false |
| true |
| true |
| edit |
| WYSIWYG HTML Editor |
| big string |
|
|
The following table shows the values of the attributes
property for the WYSIWYG HTML Editor
propertyView
:
Key | Value |
---|---|
| Height of EditLive applet, in pixels |
| Width of EditLive applet, in pixels |
| Number of columns |
| Default value for field |
| Spell check dictionary to use |
| Maximum length of the data in the field |
| Number of rows |
| Switch to show the applet in simple mode |
| Allow spell check on the field |
| Text to display above the field |
| Text to display below the field |
| Replacement field title |
See Creating View Mapping Repository Items for the basic procedure for creating a propertyView
item. For more information on the WYSIWYG HTML editor, see Configuring the EditLive! HTML Editor.
Note: When specifying a property name in a propertyView
item, you must use the property’s actual name as specified in the repository, which is not necessarily its display name in the ATG Business Control Center. You can determine a property’s name through the ATG Dynamo Server Admin: include the Admin UI module during application assembly as described in the ATG Installation and Configuration Guide, then use the Component Browser to navigate to the repository that contains the asset type you are working with.
Hiding Properties
By default, all standard views display all properties of an asset. To prevent a particular property from appearing in the ATG Business Control Center, set up a propertyViewMapping
for that property and map it to a Hidden propertyView
.
If there are many properties you wish to hide, use the pws:categorize tag.
Sorting Properties
The order in which properties appear on a page is controlled by the pws:categorize tag, which includes attributes you can use to sort properties by their category
value in the repository definition file. You can also use this tag to restrict the properties that appear on a page, either individually or by category.