You are here: Leader.IT>MasonSQL Web>AddingChildFrame>FrameHtml (22 Apr 2018, GuidoBrugnara)Edit Attach

frame.html

On this page:

Input Parameters

Input Parameter	Description	Default Value
`form`	Indicates which type of form will be displayed in the father window [`FORM, LINEAR, TABLE, DIVS or TEMPLATE`]. If it's not defined and the FATHER_TEMPLATE exists it is overloaded with it. The value of the FORM_TYPE takes the highest precedence.	By default set to `FORM`.
`children`	Defines a form type of children. If it's not defined and the CHILDREN_TEMPLATE exists it is overloaded with it. The individual CHILD_TEMPLATE takes higher precedence than the `children` parameter. The value of the FORM_TYPE takes the highest precedence.	By default set to `TABLE`.
`children_container`	Is used for displaying the children tabs.	By default set to `'Tab'`. Set to 'Stack' when there is one child.
`rows`	If declared it indicates the number of rows displayed in the form. Is relevant for `TABLE` or `DIVS` forms. The value of the TABLE_ROWS method takes precedence over the `rows`.	Set to `1` for `FORM`, `TEMPLATE`, `LINEAR` forms; Set to `10` for `TABLE` or `DIVS` forms.
`group_cols`	The number of groups dividing the table horizontally. The `rows` must be multiple of `group_cols`. The value of the TABLE_GROUP_COLS method takes precedence over `group_cols`.	`1`
`rows_child`	It indicates the number of rows displayed in a child form(s). The value declared in the child table(s) with TABLE_ROWS method takes precedence over `rows_child`.	`undef`
`group_cols_child`	The number of groups dividing the child table(s) horizontally.	`1`
`find_area`	Position of the find-bar [`top, bottom, left, right`]; Value `none` hides the find-bar.	Set to FIND_AREA if it exists, otherwise set to `left`.
`find_area_child`	Position of the find-bar of the child table(s). Only available position is `top`	The default value `undef` indicates it's hidden.
`find_component`	The name of the component that is used for the filter function in the find-bar.	By default the method FIND is used for the `top` or the `bottom` positions of the find-bar. And the method FIND_MENU is used for `left` or `right` positions of the find-bar.
`disp_navbar`	Enable navigation buttons.	`1` Enabled.
`disp_cancel`	Enable `Annulla` button.	`1`
`disp_refresh`	Enable `Aggiorna` button.	`1`
`disp_change`	Enable `Modifica` button.	`1`
`disp_insert`	Enable `Insertimento` button.	`1`
`disp_dup`	Enable `Duplicazione` button.	`1`
`disp_save`	Enable `Salva` button.	`1`
`disp_delete`	Enable `Cancella` button.	`1`
`disp_print`	Enable `Stampa` button.	`1`
`disp_xls`	Enable export to `XLS` button.	`1`
`disp_log`	Enable show `Log` button.	`1`
`find_key`	The method that will be executed during first loading of the table's record-set.	`undef`
`father_id`	A value of the specified key field from the father table used for selecting records. See the FATHER method for more detailed information.	`''`
`father_id_update`	A value of the specified key field from the father table used for modifying records. See the FATHER method for more detailed information.	`''`
`mode`	Position at the start of a record-set [`rewind`] or in the middle [`insert`].	`'rewind'`
`form_include_pre`	Name of the method to be included at the top of the father form. Similar to FORM_INCLUDE_PRE method.	`undef`
`form_include_post`	Name of the method to be included at the bottom of the father form. Similar to FORM_INCLUDE_POST method.	`undef`
`Detail_from`	Show a buttons in the father form for opening more detailed entry forms.	`undef`
`childrenDetail_from`	Show a buttons in the children forms for opening more detailed entry forms.	`undef`
`where2`	A filter query to be passed to the main record-set.	`undef`
`pk`	Primary key value to use in the `where2` filter.	`undef`
`prefix`	A prefix that is prepended to the document IDs of a record-set.	`undef`
`MenuDescrOnRight`	It is checked in the `find_component` methods. If not empty it causes placement of the descriptions of the fields in the search menu to the right of the field, instead of above. The MENU_DESCR_ON_RIGHT method takes precedence over `MenuDescrOnRight`.	`undef`
`min_height`	Minimum form height.	`'200px'`
`height`	Height of the father container.	When undefined the height is '100%'.

Methods Used

Method Name	Description	Default Contents	Example
`DESCRIPTION`	The contents of the `DESCRIPTION` is displayed in the FORM_HEADER.	Empty by default.	`<%method DESCRIPTION>Employees example (6)</%method>`
`TITLE`	If it exist it replaces the `DESCRIPTION` in the title of the child container.	Empty by default.	`<%method TITLE>Employees (6)</%method>`
`TABLE_ROWS`	Defines a number of rows that will be displayed in the TABLE or DIVS form. It overrides the rows parameter.	By default it does not exist.	`<%method TABLE_ROWS>15</%method>`
`TABLE_GROUP_COLS`	Defines a number of groups dividing the table horizontally. It overrides the group_cols parameter. The number of rows must be multiple of `group_cols`.	By default it does not exist.	`<%method TABLE_GROUP_COLS>2</%method>`
`PERL_EVAL_PRE`	Includes a Perl code called at the beginning of the page construction.	Empty by default.	See contents of the `/opt/masonsql/htdocs/data/public/funzioni.common.mql` which is inherited by the `funzioni_help.mql` and `funzioni_permessi.mql`.
`CONTROLS_INCLUDE_PRE`	Can be defined in `.mql` file to include a HTML code at the beginning of the CONTROLS bar.	Empty by default.
`CONTROLS_INCLUDE_POST`	Contains a HTML code at the end of the CONTROLS bar.	Empty by default.
`FATHER_TEMPLATE`	If it is defined it overloads the `form` parameter. The `FORM_TYPE` takes precedence over the `FATHER_TEMPLATE`.	By default it does not exist.	`<%method FATHER_TEMPLATE>TABLE</%method>`
`CHILDREN_TEMPLATE`	Is used for forcing different template to children by father but individual `CHILD_TEMPLATE` takes precedence.	The default value is `'TABLE'`	Other values: `<%method CHILDREN_TEMPLATE>FORM</%method>`, `<%method CHILDREN_TEMPLATE>DIVS</%method>`, `<%method CHILDREN_TEMPLATE>LINEAR</%method>` or `<%method CHILDREN_TEMPLATE>TEMPLATE</%method>`
`CHILD_TEMPLATE`	Forces template to its child table, even takes precedence over `CHILDREN_TEMPLATE`. The `from` parameter is passed to this method so the method can use it to decide the right `CHILD_TEMPLATE`.	By default it does not exist.	`<%method CHILD_TEMPLATE>FORM</%method>`, `<%method CHILD_TEMPLATE>TABLE</%method>`, `<%method CHILD_TEMPLATE>DIVS</%method>`, `<%method CHILD_TEMPLATE>LINEAR</%method>` or `<%method CHILD_TEMPLATE>TEMPLATE</%method>`
`FORM_TYPE`	A form type of the displayed record-set. The method has no influence during standard operation.	By default it does not exist.	`<%method FORM_TYPE>FORM</%method>`
`FORM_HEIGHT`	Sets the height of the form window (container). It is used during the initialization of the `masonSql` object.	The default `FORM_HEIGHT` does not exist. When it is not defined the Javascript function `frameLoad_Handler()` calculates the height itself.	`<%method FORM_HEIGHT>344</%method>` Represents hight in pixels.
`FORM_KEYS_MOVEMENT`	Configures keys to navigate between form fields: `ENTER` selects the next row; `ARROWS` enables selecting fields with cursor arrows.	Empty by default.	`<%method FORM_KEYS_MOVEMENT>ARROWS ENTER</%method>`
`FORM_INCLUDE_PRE`	Offers the possibility to include HTML code just before FORM_HEADER.	By default it does not exist.
`FORM_INCLUDE_POST`	Offers the possibility to include HTML code at the end of the form window (container).	By default it does not exist.	An examples of the `FORM_INCLUDE_POST` method can be found in the `/opt/masonsql/htdocs/data/public/` directory in the `messages.mql`, `user_messages.mql`, `logs.mql`, `logs_report.mql` files.
`FIELDS_INCLUDE_PRE`	Offers the possibility to include HTML code just before the form.	By default it does not exist.
`DETAIL_FROM`	Defines whether to show a buttons in the father form for opening more detailed entry forms when it's not specified otherwise by the Detail_from parameter.	By default it does not exist.	`<%method DETAIL_FROM>messages_users_detail</%method>`
`CONFIRM_DEL_MESSAGE`	Contains the message that is displayed the `Confirm deletion of the selected record` message box.	`<%method CONFIRM_DEL_MESSAGE>Conferma cancellazione dei record selezionati</%method>`	`<%method CONFIRM_DEL_MESSAGE>Potrdi izbris izbrane vrstice</%method>`
`FIND_AREA`	Defines the position of the find-bar when it's not specified otherwise by the find_area parameter.	By default it does not exist. When the `find_area` is not specified and the `FIND_AREA` does not exist the default position of the find-bar is on the `left`.	`<%method FIND_AREA>2</%method>`
`FIND_FIELDS`	A list of fields that will be displayed in the find bar on the left side of the page.	`<%method FIND_FIELDS><& SELF:FIELDS &></%method>` By default list of find-fields is identical the list from the FIELDS method.	`<%method FIND_FIELDS>login, nome, cognome, descrizione, codice_fiscale</%method>` Note: if you use `width` parameter in the widget used in `<%method myfield_FIELD>` it is important to define `width` at the left of `%ARGS` , so the widget used to render `find` field will have the `width` defined in the parameters hash `%ARGS` . Eg. `<%method myfield_FIELD><& /input/string.comp, width => 300, %ARGS &></%method>`
`FIND_FIELDS_DESCR`	Labels for the find-fields.	The method is empty by default which indicates the labels are taken from the `FIELDS_DESCR` or, if there's no labels, from the original names from the find-field's list.	`<%method FIELDS_DESCR>Nome\, Cognome, Codice Fiscale, Descrizione, Login</%method>`
`MENU_DESCR_ON_RIGHT`	It causes placement of the descriptions of the fields in the search menu to the right of the field, instead of above. It overrides the value of the MenuDescrOnRight parameter.	By default it does not exist.	`<%method MENU_DESCR_ON_RIGHT>1</%method>`
`FIELDS_INCLUDE_PRE`	A method that is called just before the main form.	By default it does not exist.
`FIELDS_INCLUDE_POST`	A method that is called just after the main form.	By default it does not exist.	An examples of the `FIELDS_INCLUDE_POST` method can be found in the `data/public/messages.mql` and `data/public/logs_report.mql` files.

Topic revision: r19 - 22 Apr 2018, GuidoBrugnara

MasonSQL