1.5. Extended settings

Interchange's meta editors use the table editor's serialization capability to set many more than just the fields mentioned above. There are over 150 different metadata settings, and it would be impossible to have each occupy a field in a table.

Many of these settings can be passed in a CGI query string if the cgi=1 option is specified.

across

The number of label-widget pairs which should be placed on each table row. The default is 1. Not passable by CGI.

action

The Interchange form action to use for the generated form. In normal mode, the default is "set". In wizard mode, the default is "return". Not passable by CGI.

action_click

An mv_click action that should be run on the Wizard next function. The default is "ui_override_next", which is usually a no-op on most systems. Not passable by CGI.

all_errors

Specifies that all form field entries should be checked for errors and their label fields set to the CONTRAST setting if an error is found.

all_opts

An ITL tag option that specifies that the table-editor options should be retrieved from one source.

If the option is a HASH reference, it will be used directly as a structure that will set all options.

If it is a scalar value, it will be used as a key to select the mv_metadata record which contains the options.

append

Active for every column in ui_data_fields. A value containing HTML which should be appended to the widget HTML.

auto_secure

Instructs Interchange to build a write enable only for the tables, columns, and keys that are specified in the table-editor call. Note that you can allow unfettered writes by setting the scratch variable mv_data_enable, but that it is rarely right to do so.

This prevents people from hacking together a duplicate of the [table-editor] form and writing columns or records they shouldn't.

This option is automatically disabled if the cgi option is enabled. Still, you should pay attention to what you are allowing users to write to your database.

back_text

The text that should be used in the Wizard Back button. Automatially translated for locale.

bottom_buttons

Indicates that buttons should always be only on the bottom. Normally, [table-editor] provides a top row of buttons if more than four rows are in the table.

break_cell_extra

Extra HTML attributes for the table cell in the standard break_row template. You might pass a valign, align, class, or other attribute:

    break-cell-extra=|class="myclass"|

break_row_extra

Extra HTML attributes for the table row in the standard break_row template. You might pass a valign, align, class, or other attribute:

    break-row-extra=|class="myclass"|

break_template

The HTML template that is used to present a break row. Default is:

        <tr$opt->{break_row_extra>
                <td colspan=$span $opt->{break_cell_extra>&nbsp;</td>
        </tr>

cancel_button_style

The HTML style for the cancel button.

cancel_text

The text placed in the "Cancel" button in both editor and wizard mode. Default is "Cancel".

cell_span

The number of cells that are in the span of a normal widget-label pair. The default is two, which is appropriate for the label in one table cell and the widget in the other. If you have a row_template like:

        <td>{LABEL}</td><td> --&gt; </td><td>{WIDGET}</td>

you would want a cell_span of three. For the row_template

        <td align=left>
                <b>{LABEL}</b><br>
                {WIDGET}
        </td>

you would want a cell_span of 1.

This allows the formatter to build the right number of cells for spacers and whole_row templates.

cgi

Signifies that some options may come from the URL calling the page where the [table-editor] resides.

This allows a simple:

        [table-editor cgi=1][/table-editor]

to be active for any table and key that are called with a URL like:

  http://your.catalog.url/cat/admin/flex_editor?mv_data_table=products?item_id=1

The auto-secure option is turned off if this option is set, for it would then be possible for people to call a table and set their own security.

check

A hash option that is active for every field. Defines a profile check that should be run on the field before the record will be allowed to be set (or the wizard allowed to go to the Next option.

This call

        [table-editor
                table=products
                item_id="[cgi sku]"
                check.description=required
        ][/table-editor]

ensures that the description field will be non-blank and non-zero before the record is written.

Works in conjunction with the process_filter profile provided as a part of the UI. If using the table editor outside the province of the UI, you will need to make sure you get this profile included; it normally resides in lib/UI/profiles.

clear_image

In cases where the table-editor templates need a transparent image for display padding, can set the path where that image is. Default is bg.gif, which comes with the Interchange UI.

color_fail

The color to set failure messages to in HTML. Default Red.

color_success

The color to set success messages to in HTML. Default Green.

data_cell_class

data_cell_style

data_cell_valign

data_cell_width

data_cell_align

data_cell_extra

The settable parameters allowing change of the HTML appearance of the data cell in the standard [table-editor] presentation. The default is data_cell_class set to cdata.

The easiest thing to do to alter the look is define the CSS class for cdata how you want it. But you can individually set the width, style, and alignments; and you can attach scripting events or other CSS calls to the cell as well with data_cell_extra.

The following table-editor call:

        [table-editor
                table=products
                item_id="[cgi sku]"
                data_cell_class=newclass
                data_cell_style="color:red"
                data_cell_extra=|onMouseOver="alert('move that mouse!'"|
                data_cell_valign=top
        ][/table-editor]

will result in a templated row of:

        <td class=clabel>{LABEL}</td>
        <td class="myclass"
                style="color:red"
                valign="top"
                onMouseOver="alert('move that mouse!')">
                        {WIDGET}{HELP?}{HELP} ... (rest of template)
        </td>

database

A hash attribute with a key associated with every field. Specifies the database table that will be used for a lookup (if any).

default

A hash attribute with a key associated with every field. Specifies the default value that will be used in the field if none is found in the table or otherwise available via the default_ref.

This is only active if the defaults flag is set.

default_ref

The hash reference that is used to set the defaults for the fields if there is no data in the table for that row. Default is $Values, the Interchange values hash.

You can set this in options with:

        [table-editor default_ref=`$CGI`]

Note the backticks. This calls Perl, which returns the $CGI reference.

If you have previously collected some defaults in a scratch variable, you could use that with:

        [table-editor default_ref=`$Scratch->{myhash}`]

Not settable in metadata, and it *must* be a hash reference or there will be a fatal error.

This is only active if the defaults flag is set.

defaults

Allows defaults to be set from the default hash above. When used in combination with force_defaults=1 forces the passed defaults to override any data previously residing in the table record.

enctype

The encoding type for the form generated by [table-editor]. If the file_upload option is set, it defaults to multipart/form-data, otherwise uses the form default for the browser (which is normally application/x-www-form-urlencoded).

extra

A hash attribute with a key associated with every field. Specifies some extra HTML parameter(s) which will be attached to the widget for the field, based on the behavior of Vend::Form.

Normally used to pass an onChange or other scripting event.

field

A hash attribute with a key associated with every field. Specifies the fields to be used as a value-label pair for a lookup (if there is one). Works in conjunction with the lookup and database tags.

To build a list of products for selection by SKU in the foo widget, without having to use the SKU as the label, you can do:

  [table-editor
        foo.widget=select
        foo.lookup=1
        foo.database=products
        foo.field="sku,description"
  /]

Essentiallly the same as:

  [table-editor
        foo.widget=select
        foo.lookup_query="select sku,description from products order by description"
  /]

file_upload

Specifies that file upload should be enabled by changing the form encoding type. Forms using the imagehelper widget need this set.

filter

A hash attribute with a key associated with every field. Specifies a filter that will be applied to the widget result data before it is put in the database. To make sure that an integer value doesn't have extraneous whitespace that could cause an error, do:

  [table-editor
        foo.widget=text_5
        foo.label="Seconds before we should become impatient and beep"
        foo.filter=digits
  /]

Filters can be chained; they are the normal Interchange filters active in many situations.

Works in conjunction with the process_filter profile provided as a part of the UI. If using the table editor outside the province of the UI, you will need to make sure you get this profile included; it normally resides in lib/UI/profiles.

force_defaults

Causes the entries in the "defaults" hash to be used to set the initial value of fields, disabling the preference for data coming from an existing record in the database.

form_extra

Extra information (usually scripting event calls) for the form. For instance, if you are maintaining a series of event monitors in and want to make sure the user knows that some changes will be lost, you can set up a routine named check_change() in JavaScript. To check the change and ask for a confirmation before submission, you can do:

  <script>
  var changed = new Array;
  function is_changed (element) {
        if(element != undefined)
                changed[changed.length] = element.name;
  }

  function check_change () {
        if(changed.length > 0)
          return
                confirm('the ' + changed.join(',') + ' elements were changed. Continue?');
        return true;
  }
  </script>

  [table-editor
        foo.widget=text_50
        foo.label="Important stuff"
        foo.extra='onChange="is_changed(this)"
        form_extra='onSubmit="return check_change()"'
  /]

You could also pass style information if that is ever appropriate. For form name, action, and target,

form_name

The name of the form. Do not include the NAME= portion, that is provided. Results in outputted HTML of:

        <FORM ACTION="$opt->{form_action}" METHOD=POST NAME="$opt->{form_name}">

get

Sets the method for the form to GET -- the default is POST.

height

A hash attribute with a key associated with every field. Sets the height of the widget if that is appropriate -- for example, it sets the ROWS parameter of a TEXTAREA, the SIZE parameter of a SELECT, etc. Also acts on the combination widgets according to the behavior of Vend::Form.

If you want to set the height of a cell, you should use the *_extra parameters.

help

A hash attribute with a key associated with every field. Specifies inline help that should be shown in the right-hand (data) portion of a widget row.

help_anchor

Sets the text that is used to anchor the help_url link. Default is help. Can also be used to set an image if you want to use that instead:

  [table-editor
        table=products
        key=os28004
        help_anchor='<img src="question_mark.jpg" border=0>'
  /]

help_cell_class

help_cell_style

help_cell_valign

help_cell_width

help_cell_align

help_cell_extra

Sets the help cell attributes. See data_cell_extra.

help_url

A URL which leads to extended help on a field. For example:

  [table-editor
        table=products
        key=os28004
        widget.foo=text_50
        label.foo="Important stuff"
        help.foo="This is a complex field."
        help_anchor="Search for more help"
        help_url.foo="http://www.google.com/search?q=foo"
  /]

hidden

Allows setting of extra hidden variables in a form. This is a hash attribute, with one key for every hidden variable you need to set.

  [table-editor
        table=products
        key=os28004
        hidden.foo=bar
        hidden.buz=baz
  /]

The above will include

        <input type="hidden" name="foo" value="bar">
        <input type="hidden" name="buz" value="baz">

href

Sets the action for the form. By default it is VendURL/ui, which checks for authorization for setting table records. If the secure=1 parameter is set, SecureURL will be used instead. parameter is set, the SecureURL the default

include_before

include_form

inner_table_width

item_id

js_changed

keep_errors

label

label_cell_extra

label_cell_width

layer_panel_style

layer_tab_style

left_width

link_before

link_extra

link_fields

link_key

link_label

link_sort

link_table

link_template

link_view

lookup

lookup_query

mailto

message_label

meta

meta_anchor

meta_anchor_specific

meta_append

meta_class

meta_extra

meta_prepend

meta_style

method

mv_auto_export

mv_blob_field

mv_blob_label

mv_blob_nick

mv_blob_only

mv_blob_pointer

mv_blob_title

mv_cancelpage

Specifies the destination page if you hit the cancel-button.

mv_data_auto_number

mv_data_fields

mv_data_function

mv_data_table

mv_failpage

mv_nextpage

mv_prevpage

next_text

You can customize an alternative text for the OK/Next button.

Note! If your alternative text is long, and you get the text chopped, be sure to specify a wider button with the ok_button_style setting (eg. ok_button_style=|font-weight: bold; width: 80px; text-align: center|)

no_bottom

By default, form buttons are displayed at the top and bottom of the table. Specifying no_bottom=1 prevents the bottom set of buttons from being displayed.

     no_bottom=1

no_meta

no_table_meta

no_top

By default, form buttons are displayed at the top and bottom of the table. Specifying no_top=1 prevents the top set of buttons from being displayed.

     no_top=1

nodelete

noexport

nosave

notable

ok_button_style

options

orig_back_text

orig_cancel_text

outboard

override

panel_append

panel_height

Specifies the height of the data panels used in the tabbed diaplay. The default is 600.

    panel_height=600

panel_id

Specifies the prefix used to identify the panels used in the tabbed display. The default is mvpan.

    panel_id=mvpan

panel_prepend

panel_style

Specifies the CSS style applied to the data panels used in the tabbed display. The default is:

    font-family: sans-serif;
    font-size: smaller;
    padding: 0;
    border: 2px;
    border-color:#999999;
    border-style:outset;

panel_width

Specifiesthe width of the data panels used in the tabbed diaplay. The default is 800.

    panel_width=800

passed

pre_filter

prepend

promiscuous

reload

reparse

restrict_allow

row_template

save_meta

secure

show_reset

simple_row

start_at

start_at_index

tab_bgcolor_template

Controls the iteration over the range of bgcolor attributes of the tabs in the tabbed display. If tab_bgcolor_template="#xx0000" the tabs will be set to "#ff0000" "#ee0000", etc. The default is "#xxxxxx" and the values are set to "#ffffff" "#eeeeee",etc. This option allows one to specify a range of colored tabs.

    tab_bgcolor_template="#xx0000"

tab_height

Specifies the height of the tabs in the tabbed display. The default is 20px.

    tab_height=20

tab_horiz_offset

Specifies the number of pixels that additional rows of tabs are shifted to the right. The default is 10px.

    tab_horiz_offset=10

tab_style

Specifies the CSS style applied to the tabs in the tabbed display. The default is:

   text-align:center;
   font-family: sans-serif;
   line-height:150%;
   font-size: smaller;
   border:2px;
   border-color:#999999;
   border-style:outset;
   border-bottom-style:none;

tab_vert_offset

Specifies the number of pixels that additional rows of tabs are shifted upward. The default is 20px.

    tab_vert_offset=20

tab_width

Specifies the width of the tabs in the tabbed display. The default is 120px.

    tab_width=120

tabbed

This option specifies that the tabbed display mode is to be used. The tabbed=1 option displays sections as DHTML tabbed panels.

table

This option specifies the table as the source / destination of the form fields. The table is specified in the form: table=products.

table_width

td_extra

template

ui_blob_hidden

ui_blob_widget

ui_break_before

ui_break_before_label

ui_clone_id

ui_clone_tables

ui_data_fields

Specifies the database fields that a form collects. This is a quoted space delimited list of column names from the database table.

     ui_data_fields="field1 field2 field3"

ui_data_fields_all

ui_data_key_name

ui_display_only

A quoted space delimited list of fields to be displayed but not edited.

    ui_display_only="property_id"

ui_hide_key

Hides the key-field in the form. Remember that if you use the fields option, then you have to include the key-column in that list. Otherwise the form will fail to update the record.

ui_meta_specific

ui_meta_view

ui_new_item

ui_profile

ui_profile_success

ui_wizard_fields

Specifies the fields that a form collects in wizard mode.

     ui_wizard_fields="wiz_field1 wiz_field2 wiz_field3"

widget

widget_cell_extra

widgets_only

width

wizard

Specifies that the form collects data as session variables as opposed to database fields. Data fields are specified using the ui_wizard_fields option.

wizard_cancel

wizard_next


Copyright 2002-2004 Interchange Development Group. Freely redistributable under terms of the GNU General Public License.