Example (attribute of property)

From JRapid

First line contains the category link and the parent element or property links. It also links to child values.

inline is an attribute of property.

Its possible values are:

• inline
• detail
• grid

Contents 1 Description 2 Usage 3 Examples 4 See also

Description

1st phrase: Minimum sufficient description that identifies the result of using this value. The summary in the first row. After that, in each row, the other necessary ideas that provide the whole description. If you use bullets, remember to enter the dot at the end of each sentence.

When a property is declared as an entity (we also call it an entity-property), it can specify embedded, which means that it exists a child entity which is strongly related (visually included or embedded) in this parent entity.

• Embedded entities represent weak relations, so they map to cascade="all" hibernate relations, and ondelete="cascade" at the database.

Single/Collection The child entity can be single (1-1) or collection (1-n).

• When an entity-property is single (not collection), the only possible value is
  • detail will embed the same form of the child entity in the parent entity's form.
• Single embedded entities appear in the database as a column of the parent-entity table.

• When an entity-property is collection, the possible values are:
  • inline will embed child entity converting properties into rows.
  • detail will embed child entity using the full child form layout.
  • grid will embed child entity as inline, adding extra columns for special tagged properties.
• Embedded collections need to specify a childproperty attribute, which specifies which property "links" to the parent entity.

Extendable/Non Extendable

• If an embedded collection does not declare extendable, the collection is read-only (users cannot add new elements apart from the provided in the opening of the form).
• For non-extendable inline collections, the values can be filled using foreach and dynamicforeach.

Usage

Taking the closest ancestor template (Do not use {{Property spec}}, enter Template:Property spec instead, and copy-paste here, leaving only required attributes + those attributes related to the parent attribute

<property
         name = NAME
         label = LABEL
         ...
         entity = ENTITY
         collection = COLLECTION
         embedded = (inline|detail|grid)
         childproperty = PROPERTY
         maxrows = ROWS
         minrows = ROWS
         listindex = LIST_INDEX
         listunique = LIST_UNIQUE
         setorder = SETORDER
         sort = SORT
         sortexpr = EXPR
         where = WHERE
         extendable = "extendable"
         sortable = "sortable"
         gridheader = "gridheader"
         gridvalue = "gridvalue" 
         displayproperties = PROPERTIES
         (foreach?, dynamicforeach?, ...)
</property>

Examples

Examples have an structure and need to be unique for the value. As we say for the description, they should not include nor explain concepts from the parent attribute.

• Business Rules
  • Data Model (Screenshot)
  • Data Model (XML Source)
• Screenshot of result
• Conclusion text

Business rules

• Main Company entity and a child Contact entity.
• Company may or may not have an Address.

   
    <entity label="Company" menu="Main" name="Company">
        <property display="primary" label="Name" name="name"/>
        <property embedded="detail" entity="Address" label="Address" name="address" labelposition="fieldset"/>
    </entity>

    <entity label="Address" name="Address">
        <property label="Street" name="street"/>
        <property label="Number" name="number"/>
        <property label="City" name="city"/>
    </entity>

• An Address is an entity itself, and is treated as it.

Here we get the child entity with its properties displayed as columns. Additionally, we get a remove-line button at the end.

See also

Most important wikiwords that appear in the article, and how they link, when needed

• embedded
• displayproperties
• extendable

Include corresponding category [[Category:Attribute]]