Template Paths - Layout hierarchies

The Server hierarchy
The Document hierarchy
The Application hierarchy
/application
- /application/ui
  - /application/ui/window
    - /application/ui/window/menu
    - /application/ui/window/dialog
    - /application/ui/window/form
      - /application/ui/window/form/grid
        
        /application/ui/window/form/grid/gridlayout
      - /application/ui/window/form/scrollgrid
        
        /application/ui/window/form/grid/gridlayout
      - /application/ui/window/form/group[...]
      - /application/ui/window/form/folder[...]
      - /application/ui/window/form/vbox[...]
      - /application/ui/window/form/hbox[...]
      - /application/ui/window/form/table[...]
      - /application/ui/window/form/table[...]/action

The LayoutContainer objects

LayoutContainer objects are in fact one of the following type :

a Grid object ;
a ScrollGrid object ;
a Group object ;
a Folder object ;
a VBox or HBox object ;
a Table object ;

These objects are selectable objects. They can be accessed using paths like objectPath[id], where id is the object name.

Example

application/ui/window/form/grid['grid1']
application/ui/window/form/scrollgrid['sg1']
application/ui/window/form/group['grp1'] 
application/ui/window/form/folder['fd1']
application/ui/window/form/vbox['vb1']
application/ui/window/form/hbox['hb1']
application/ui/window/form/table['table1']

Back to the top

The Grid object

Path: application/ui/window/form/grid[name] or relative paths according to sequences.

Snippet ID: Grid

Corresponding AUI Tree element: Grid

The Grid is a LayoutContainer.

This object value is rendered thru the Grid snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes)	Type	Description
`CID`	Attribute (string)	The corresponding component identifier.
`type`	Attribute (string)	Type of the component.
`name`	Attribute (string)	Grid identifier.
`hidden`	Attribute (number)	Corresponds to the HIDDEN attribute in 4GL.
`tag`	Attribute (string)	Corresponds to the attribute TAG value.
`style[ attribute-name ]`	Attribute (string)	This selectable path will return the given attribute value inherited for this window. See Customizing with Genero Presentation Styles for more details.
`class`	Attribute (string)	Corresponds to the attribute STYLE value.
`layout`	Object	A GridLayout object describing the layout for this given grid.

Back to the top

The ScrollGrid object

Path: application/ui/window/form/scrollgrid[name] or relative paths according to sequences.

Snippet ID: ScrollGrid

Corresponding AUI Tree element: ScrollGrid

The ScrollGrid is a LayoutContainer.

This object value is rendered thru the ScrollGrid snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes)	Type	Description
`CID`	Attribute (string)	The corresponding component identifier.
`type`	Attribute (string)	Type of the component.
`name`	Attribute (string)	ScrollGrid identifier.
`hidden`	Attribute (number)	Corresponds to the HIDDEN attribute in 4GL.
`tag`	Attribute (string)	Corresponds to the attribute TAG value.
`style[ attribute-name ]`	Attribute (string)	This selectable path will return the given attribute value inherited for this window. See Customizing with Genero Presentation Styles for more details.
`class`	Attribute (string)	Corresponds to the attribute STYLE value.
`offset`	Attribute (number)	ScrollGrid offset
`size`	Attribute (number)	Size of the associated array.
`pageSize`	Attribute (number)	Number of rows displayed by the scrollGrid.
`isScrollable`	Attribute (boolean)	True if you can scroll in the array.
`pages`	Collection of untyped object	A collection of untyped object to be able to iterate on the ScrollGrid pages.
`layout`	Object	A GridLayout object describing the layout for this given grid.

Back to the top

The GridLayout object

Path: grid/layout or scrollgrid/layout

Snippet ID: GridLayout

The GridLayout is a sub-oject of Grid or ScrollGrid describing the grid layout.

This object value is rendered thru the GridLayout snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes)	Type	Description
`CID`	Attribute (string)	The corresponding component identifier.
`type`	Attribute (string)	Type of the component.
`GID`	Attribute (string)	GridLayout identifier
`data`	Attribute (string)	Data to handle the layout design for JavaScript.
`width`	Attribute (number)	GridLayout width.
`height`	Attribute (number)	GridLayout height.
`marginLeft`	Attribute (number)	Width of the smallest empty cell on the left hand side of the grid. If one line of the grid begins with a occupied cell, the margin is 0.
`marginRight`	Attribute (number)	Width of the smallest empty cell on the right hand side of the grid. If one line of the grid ends with a occupied cell, the margin is 0.
`lines`	Collection of GridLayoutLine objects	A collection of grid lines.
`tableLines`	Collection of GridLayoutTableLine objects	A collection of grid table lines. Enable the layout of a grid content to be fully based on a HTML table. Compared to the `lines` collection, the rowspan attribute of a TD element can be directly mapped to the cell's height attribute.

Back to the top

The GridLayoutLine object

Path: relative paths according to sequences.

The GridLayoutLine is a sub-object of GridLayout describing one grid line.

Fields (Attributes)	Type	Description
`cells`	Collection of GridLayoutCell objects	List of cells containg a widget.
`allcells`	Collection of GridLayoutCell objects	List of all cells having a widget or not.

Back to the top

The GridLayoutTableLine object

Path: relative paths according to sequences.

The GridLayoutTableLine is a sub-object of GridLayout describing one grid line.

Fields (Attributes)	Type	Description
`cells`	Collection of GridLayoutCell objects	List of cells.

Back to the top

The GridLayoutCell object

Path: relative paths according to sequences.

The GridLayoutCell is a sub-object of GridLayoutLine describing one grid cell.

Fields (Attributes)	Type	Description
`GID`	Attribute (string)
`isEmpty`	Attribute (boolean)	True if the cell does not contain a widget.
`x`	Attribute (number)	The cell x coordinate in the Grid.
`y`	Attribute (number)	The cell y coordinate in the Grid.
`width`	Attribute (number)	The cell width.
`height`	Attribute (number)	The cell height.
`item`	Object	A LayoutContainer object or a GridElem object filling this grid cell.

Back to the top

The Group object

Path: application/ui/window/form/group[name] or relative paths according to sequences.

Snippet ID: Group

Corresponding AUI Tree element: Group

The Group is a LayoutContainer.

This object value is rendered thru the Group snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes)	Type	Description
`CID`	Attribute (string)	The corresponding component identifier.
`type`	Attribute (string)	Type of the component.
`name`	Attribute (string)	Group identifier.
`hidden`	Attribute (number)	Corresponds to the HIDDEN attribute in 4GL.
`tag`	Attribute (string)	Corresponds to the TAG attribute value.
`style[ attribute-name ]`	Attribute (string)	This selectable path will return the given attribute value inherited for this window. See Customizing with Genero Presentation Styles for more details.
`class`	Attribute (string)	Corresponds to the STYLE attribute value.
`item`	Object	A LayoutContainer object describing the content of the group.

Back to the top

The Folder object

Path: application/ui/window/form/folder[name] or relative paths according to sequences.

Snippet ID: Folder

Corresponding AUI Tree element: Folder

The Folder is a LayoutContainer.

This object value is rendered thru the Folder snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes)	Type	Description
`CID`	Attribute (string)	The corresponding component identifier.
`type`	Attribute (string)	Type of the component.
`name`	Attribute (string)	Folder identifier
`text`	Attribute (string)	Folder title.
`hidden`	Attribute (number)	Corresponds to the HIDDEN attribute in 4GL.
`tag`	Attribute (string)	Corresponds to the TAG attribute value.
`style[ attribute-name ]`	Attribute (string)	This selectable path will return the given attribute value inherited for this window. See Customizing with Genero Presentation Styles for more details.
`class`	Attribute (string)	Corresponds to the STYLE attribute value.
`pages`	A collection of FolderPage object	The list of all pages in this folder.
`page[page-name]`	Object	This selectable path will return the FolderPage object of the folder with this given name. If no selection is explicitely done. This path will return the current FolderPage object.

Back to the top

The FolderPage object

Path: relative paths according to sequences.

The FolderPage is a sub-object of Folder describing one folder page.

Fields (Attributes)	Type	Description
`CID`	Attribute (string)	The corresponding component identifier.
`type`	Attribute (string)	Object type.
`id`	Attribute (string)	Object identifier.
`IDID`	Attribute (string)	Dialog identifier in inlcusive format. For example: `<input type="submit" gwc:attributes="name p/IDID;"... />` produces: `<input type="submit" name="p88/89"... />`
`XDID`	Attribute (string)	Dialog identifier in exclusive format. For example: `<input type="radio" gwc:attributes="name p/XDID; value p/ID;... />` produces: `<input type="radio" name="p88" value="89".. />`
`name`	Attribute (string)	FolderPage identifier
`text`	Attribute (string)	Folder page title.
`hidden`	Attribute (number)	Corresponds to the HIDDEN attribute in 4GL.
`tag`	Attribute (string)	Corresponds to the TAG attribute value.
`style[ attribute-name ]`	Attribute (string)	This selectable path will return the given attribute value inherited for this window. See Customizing with Genero Presentation Styles for more details.
`class`	Attribute (string)	Corresponds to the STYLE attribute value.
`image`	Attribute (string)	Corresponds to the IMAGE attribute value.
`comment`	Attribute (string)	Corresponds to the COMMENT attribute value.
`isCurrent`	Attribute (boolean)	True if the FolderPage is selected.
`hasAction`	Attribute (boolean)	True if the FolderPage has an associated Action.
`body`	Object	A LayoutContainer object describing this page content.

Back to the top

The Box object

Path: application/ui/window/form/vbox[name] or application/ui/window/form/hbox[name] or relative paths according to sequences.

Snippet ID: VBox or HBox

Corresponding AUI Tree element: VBox or HBox

The Box is a LayoutContainer.

This object value is rendered thru the VBox or HBox snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes)	Type	Description
`CID`	Attribute (string)	The corresponding component identifier.
`type`	Attribute (string)	Type of the component.
`name`	Attribute (string)	LayoutContainer identifier.
`hidden`	Attribute (number)	Corresponds to the HIDDEN attribute in 4GL.
`tag`	Attribute (string)	Corresponds to the TAG attribute value.
`style[ attribute-name ]`	Attribute (string)	This selectable path will return the given attribute value inherited for this window. See Customizing with Genero Presentation Styles for more details.
`class`	Attribute (string)	Corresponds to the STYLE attribute value.
`items`	Collection of LayoutContainer objects	A list of the layout element to render vertically or horizontally.

Back to the top

The Table object

Path: application/ui/window/form/table[name] or relative paths according to sequences.

Snippet ID: Table

Corresponding AUI Tree element: Table

The Table is a LayoutContainer.

This object value is rendered thru the Table snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes)	Type	Description
`CID`	Attribute (string)	The corresponding component identifier.
`type`	Attribute (string)	Type of the component.
`id`	Attribute (string)	Table identifier.
`name`	Attribute (string)	Table name.
`offset`	Attribute (number)	Table offset.
`scrollOffsetXDID`	Attribute (string)	Offset of the Table in exclusive format. See the function makeScrollOffsetIDID to use the inclusive format. Syntax: `control-name=control-value`where `control-name` is scrollOffsetXDID and `control-value` is an offset value. Example: `<input type="radio" gwc:attributes="name pageSizeXDID; value '50';... />` produces `<input type="radio" name="s88" value="50"... />`
`pageSize`	Attribute (number)	Number of rows displayed by the Table.
`pageSizeXDID`	Attribute (string)	Number of rows displayed by the Table in exclusive format. See the function makePageSizeIDID to use the inclusive format. Syntax: `control-name=control-value`where `control-name` is pageSizeXDID and `control-value` is a size value. Example: `<input type="radio" gwc:attributes="name pageSizeXDID; value '50';... />` produces `<input type="radio" name="s88" value="50"... />`
`size`	Attribute (number)	Number of rows in the underlying array.
`isSelectable`	Attribute (boolean)	True if you can select a row of the Table (for example in a display)
`isScrollable`	Attribute (boolean)	True if you can scroll the Table rows (for example in a input).
`isSortable`	Attribute (boolean)	True if the attribute UNSORTABLECOLUMNS si set to false.
`isModifiable`	Attribute (boolean)	True if you can type in the table (for example in an input).
`sortType`	Attribute (string)	Value is "asc" if the sorting is ascendant. Value is "desc" if the sorting is descendant.
`currentRow`	Attribute (number)	Index of the selected line.
`style[ attribute-name ]`	Attribute (string)	This selectable path will return the given attribute value inherited for this window. See Customizing with Genero Presentation Styles for more details.
`class`	Attribute (string)	Corresponds to the STYLE attribute value.
`columns`	Collection of Table Column objects	A list of the columns in this table.
`rows`	Collection of Table Row objects	A list of the rows in this table.
`action`	Object	A TableAction object describing the action associated with the double-click user action for this table.

Back to the top

The Table Column object

Path: relative paths according to sequences.

Corresponding AUI Tree element: TableColumn

The TableColumn is a sub-object from the Table describing one column header.

Fields (Attributes)	Type	Description
`DID Deprecated !`	Attribute (String)	Dialog identifier. This path is deprecated use IDID or XDID instead.
`IDID`	Attribute (string)	Dialog identifier in inclusive format. For example: `<input type="submit" gwc:attributes="name c/IDID;"... />`where c is the column object produces: `<input type="submit" name="c88/89"... />`
`XDID`	Attribute (string)	Dialog identifier in exclusive format. For example: `<input type="radio" gwc:attributes="name c/XDID; value c/ID;... />` where c is the column object produces: `<input type="radio" name="c88" value="89"... />`
`columnSortXDID`	Attribute (string)	Dialog identifier in exclusive format. See also function makeTableNoSortValue.
`text`	Attribute (string)	Column title.
`name`	Attribute (string)	Column identifier.
`isModifiable`	Attribute (boolean)	True if the columns is in input mode.
`isSortable`	Attribute (boolean)	True is the attribute UNSORTABLE is set to false.
`isSorted`	Attribute (boolean)	True if the Column is already sorted.
`hidden`	Attribute (number)	Corresponds to the HIDDEN attribute in 4GL.
`tag`	Attribute (string)	Corresponds to the TAG attribute value.

Back to the top

The Table Row object

Path: relative paths according to sequences.

Corresponding AUI Tree element: TableColumn/ValueList

The TableRow is a sub-object from the Table describing one row content.

Fields (Attributes)	Type	Description
`DID Deprecated !`	Attribute (string)	Dialog identifier. This path is deprecated use XDID path or makeRowSelectionDID function instead.
`XDID`	Attribute (string)	Dialog identifier in exclusive format. To use the inclusive format see the function makeRowSelectionIDID. Syntax: `control-name=control-value` where the `control-name` is the row id and `control-value` is the row index. Example: `<input type="radio" gwc:attributes="name r/XDID; value repeat/r/index;... />` produces `<input type="radio" name="r89" value="50"... />`
`id`	Attribute (string)	Row identifier.
`isCurrent`	Attribute (boolean)	True if the row is selected.
`cells`	Collection of Table Cell objects	A list of the cells in this table row.

Back to the top

The Table Cell object

Path: relative paths according to sequences.

Corresponding AUI Tree element: TableColumn/ValueList/Value

The TableCell is a sub-object from the TableRow describing one cell content.

Fields (Attributes)	Type	Description
`hidden`	Attribute (number)	True if the Cell is not visible.
`item`	Object	A Widget object describing the widget filling this cell.
`column`	Object	A Table Column object describing the column of the current cell.

Back to the top

The TableAction object

Path: table/action

Snippet ID: TableAction

Corresponding AUI Tree element:

The TableAction is a sub-object of Table object that represent the action to activate when the user double-click on a table row.

This object value is rendered thru the TableAction snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes)	Type	Description
`CID`	Attribute (string)	The corresponding component identifier.
`type`	Attribute (string)	Object type (see ... for more details)
`DID Deprecated !`	Attribute (string)	Dialog identifier. This path is deprecated use XDID path or makeValueIDID function instead.
`name`	Attribute (string)	Action name.
`text`	Attribute (string)	Text displayed for the Action.
`image`	Attribute (string)	Image assoiated to the Action.
`comment`	Attribute (string)	Comment for the Action.
`isActive`	Attribute (boolean)	True if the Action is active.
`hidden`	Attribute (number)	Corresponds to the HIDDEN attribute in 4GL.
`tag`	Attribute (string)	Value of the TAG attribute.

Back to the top