Global object form options
- Source:
- globals.js, line 658
Members
-
<static> actionAutoSave
-
- Source:
- globals.js, line 763
Properties:
Name Type Description actionAutoSave
boolean auto-save form on custom action (default true) -
<static> actions
-
- Source:
- globals.js, line 785
Properties:
Name Type Description actions
object Form actions { form, formPlus } arrays of actions {name, label, confirm, callback...}
undefined: generate actions with user rights, null = no action -
<static> activateSaveOnChange
-
- Source:
- globals.js, line 756
Properties:
Name Type Description activateSaveOnChange
boolean Activate the save button is a field has changed ? (default false: save is always active) -
<static> areaColumns
-
- Source:
- globals.js, line 967
Properties:
Name Type Description areaColumns
number columns per area without template (default 2) -
<static> beforeload
-
- Source:
- globals.js, line 676
Properties:
Name Type Description beforeload
function(ctn,obj,params) optional handler before loading the form data -
<static> constraints
-
- Source:
- globals.js, line 927
Properties:
Name Type Description constraints
boolean apply constraints (true by default) -
<static> container
-
- Source:
- globals.js, line 669
Properties:
Name Type Description container
string Target UI container #work if unset) -
<static> copy
-
- Source:
- globals.js, line 906
Properties:
Name Type Description copy
boolean true to get the item for copy -
<static> createLinks
-
- Source:
- globals.js, line 878
Properties:
Name Type Description createLinks
boolean Allow global foreign-keys creation, default: true to set refField.createLink.enabled=true -
<static> display
-
- Source:
- globals.js, line 700
Properties:
Name Type Description display
function(ctn,obj,params,cbk) optional to override default rendering -
<static> floating
-
- Source:
- globals.js, line 792
Properties:
Name Type Description floating
boolean true to ensure actions visible on vertical scroll -
<static> floating
-
- Source:
- globals.js, line 425
Properties:
Name Type Description floating
boolean true to ensure actions visible on vertical scroll -
<static> followLinks
-
- Source:
- globals.js, line 871
Properties:
Name Type Description followLinks
boolean Allow global references navigation, default: true to set refField.followLink.enabled=true -
<static> formTab
-
- Source:
- globals.js, line 885
Properties:
Name Type Description formTab
object current selected tab index -
<static> help
-
- Source:
- globals.js, line 828
Properties:
Name Type Description help
string Contextual form help -
<static> inst
-
- Source:
- globals.js, line 899
Properties:
Name Type Description inst
string optional instance name -
<static> isExtended
-
- Source:
- globals.js, line 814
Properties:
Name Type Description isExtended
boolean Show/Hide extended fields on form (default false) -
<static> msg
-
- Source:
- globals.js, line 821
Properties:
Name Type Description msg
(string | object)[] Optional array of (backend) messages -
<static> nav
-
- Source:
- globals.js, line 835
Properties:
Name Type Description nav
string Optional navigation 'new' or 'add', to navigate on list 'first', 'prev', 'next' or 'last' -
<static> onclose
-
- Source:
- globals.js, line 749
Properties:
Name Type Description onclose
function(ctn,obj) handler to close form, default: engine.closeForm = nav back -
<static> onhelp
-
- Source:
- globals.js, line 770
Properties:
Name Type Description onhelp
function(ctn,obj) handler to display the long help, default engine.displayHelp -
<static> onload
-
- Source:
- globals.js, line 688
Properties:
Name Type Description onload
function(ctn,obj,params) optional handler after loading the form -
<static> onsave
-
- Source:
- globals.js, line 721
Properties:
Name Type Description onsave
function(ctn,obj,cbk) handler to save form, default: engine.saveForm and reload -
<static> onsaveclose
-
- Source:
- globals.js, line 728
Properties:
Name Type Description onsaveclose
function(ctn,obj,cbk) handler to save and close form, default: engine.saveForm + closeForm -
<static> onsavecopy
-
- Source:
- globals.js, line 742
Properties:
Name Type Description onsavecopy
function(ctn,obj,cbk) handler to save and copy, on creation by default -
<static> onsavenew
-
- Source:
- globals.js, line 735
Properties:
Name Type Description onsavenew
function(ctn,obj,cbk) handler to save and create, on creation by default -
<static> onsocial
-
- Source:
- globals.js, line 777
Properties:
Name Type Description onsocial
function(ctn,obj) handler to display the social posts, default engine.displaySocial -
<static> onunload
-
- Source:
- globals.js, line 694
Properties:
Name Type Description onunload
function(ctn,obj,params) optional handler before unloading the form -
<static> parent
-
- Source:
- globals.js, line 920
Properties:
Name Type Description parent
object optional parent context { name, inst, field, rowId } needed for creation -
<static> preload
-
- Source:
- globals.js, line 682
Properties:
Name Type Description preload
function(ctn,obj,params) optional handler before rendering the form (data loaded) -
<static> readonly
-
- Source:
- globals.js, line 807
Properties:
Name Type Description readonly
boolean Read only ? apply on fields, use onsave|onclose|actions|transitions to disable buttons -
<static> showAreas
-
- Source:
- globals.js, line 856
Properties:
Name Type Description showAreas
string Display fields areas in 'tabs' or 'split' mode -
<static> showNav
-
- Source:
- globals.js, line 842
Properties:
Name Type Description showNav
boolean Display the navigation bar (default true) -
<static> showOptions
-
- Source:
- globals.js, line 849
Properties:
Name Type Description showOptions
boolean Display the options menu (default true) -
<static> showViews
-
- Source:
- globals.js, line 864
Properties:
Name Type Description showViews
boolean | string Display views mode
false/true or 'tabs' / 'vertical' tabs / 'split' all panels vertically -
<static> template
-
- Source:
- globals.js, line 935
Properties:
Name Type Description template
string Global form template with dynamic elements:
icon-title, form-title, form-actionbar, form-areas, form-navbar, area, action, field, text -
<static> title
-
- Source:
- globals.js, line 707
Properties:
Name Type Description title
string Form title, default: function object.ui.title = user key -
<static> transitions
-
- Source:
- globals.js, line 800
Properties:
Name Type Description transitions
object[] arrays of transition actions {name, label, confirm, callback...}
undefined: based on metadata, null = no transitions -
<static> values
-
- Source:
- globals.js, line 714
Properties:
Name Type Description values
object value per field, default: call the get service on rowId -
<static> viewTab
-
- Source:
- globals.js, line 892
Properties:
Name Type Description viewTab
string current selected view tab, default: metadata.defaultView if undefined -
<static> workflow
-
- Source:
- globals.js, line 913
Properties:
Name Type Description workflow
boolean true when the form is displayed within a workflow