Interface listParameters

Optional view attributes

interface listParameters {
    beforeSaveControls?: dataControl[];
    buttonLine?: buttonLineSettings;
    clipParams?: fclipParams;
    commandLine?: buttonLineSettings;
    contextMenu?: boolean | buttonLineSettings;
    contextObj?: string;
    defViewName?: boolean;
    drag?: string | boolean;
    drop?: string;
    dropAccepted?: boolean | string[];
    dropObjectsToList?: string[];
    editable?: string;
    emptyIcon?: string;
    filterhelp?: boolean;
    groupBy?: string;
    iconPos?: "left" | "right" | "leftTop" | "rightTop";
    longSearch?: boolean;
    newAction?: string;
    noBgColor?: boolean;
    noDefButtons?: boolean;
    noEnPrintOperation?: boolean;
    noFilters?: boolean;
    operList?: string;
    principalObject?: string;
    printOperation?: string | boolean;
    readonly?: string | boolean | string[];
    reminders?: true;
    right?: string;
    rowEditable?: string;
    schedParams?: scheduleParams;
    selfReadonly?: boolean;
    singleOnly?: boolean;
    snewButton?: boolean;
    strangeRowIcon?: string;
    style?: any;
    subToList?: string | boolean;
    tableOptions?: iDataTableOptions;
    treeView?: string | boolean;
    userNotes?: boolean;
    userSigns?: boolean;
    visible?: string;
}

Hierarchy (view full)

Properties

beforeSaveControls?: dataControl[]

List of controls that are specific for view and made before save

  • Note: when user does not set value to the attribute, controls defined for a field are not performed. So that if control should check null value, it should be defined in this section.
  • Supported only by univDetail safe function nowhere else
  • each field is evaluated by the eval function, they are not operation!

Example

sysFile - there are 3 fields that can be null but not all, control is made using this option
buttonLine?: buttonLineSettings

setting for button lines

clipParams?: fclipParams

Optional parameters allows settings param values directly for clip, simplify parameter transfer and overload code. If clip has self attributes defined, these has higher priority than those that comes from paramters

commandLine?: buttonLineSettings

setting for the command line

contextMenu?: boolean | buttonLineSettings

setting for menu items Although not explicitky written, this supports contextMenu = true - to show menu even for subitems

contextObj?: string

Optional name of the object that makes context of the view

Example

for view with list of contacts from address book the context object is the addressbook

Value is not regularly used and makes sense only for views that has contextObj loaded togehter with the content; usually the contex is derived from master and defined by the view
defViewName?: boolean

Settings that set defViewName option of the univDetail Changes how name of the window is defined and uses default name from translation instead of the object name Supported only by univDetail

drag?: string | boolean

Condition when view allows drag operation; Supported only for clip and detail (for detail it is supported by title)

drop?: string

String used use return object that is used as location where dragged object is dropped. If not defined default object is used but this allows return different object

Currently supported only by clip or clipList, no other objects

dropAccepted?: boolean | string[]

List of objectNames accepted for drop Object that supports drop object must implement back-end method server.dropObject with attributes objectName / objectID

Warnings:

  • When used in the list view - than it defines what is accpeted by list header not list lines, Use dropObjectsToList for list lines
  • When boolean,
    • false is the same as nothing - no reason to write
    • true - all objects are accepted and there should be drop_anyObject method to serve any object
dropObjectsToList?: string[]

Section used only by list views - optional redefition what object accepts the list field

editable?: string

equal to editable, item is readonly in case that this is false - clausule simplification, not used if readonly defined; has lower priority than readonly but it is strongly recommended not to use both of them

emptyIcon?: string

Name of the icon used instead of default icon in case that there are no fields in the list Not evaluated, only icon name allowed Makes sense only for list and clipList

filterhelp?: boolean

Optional attribute set that view displays also hint for filters Makes sense everywhere where are used filters - list, cliplist and clip (for cliplist not yet implemented) Only bool value supported; never evaluated

groupBy?: string

Optional function / name of the column used for grouping

iconPos?: "left" | "right" | "leftTop" | "rightTop"

icon position in the view (currently supported only by clip detail in full scope)

  • positions are defined by the view structure
  • top positions are in the size of the large letter
longSearch?: boolean

When true, application waits much longer time for search results. Used for complicated searches like files where are rights controlled for each result

newAction?: string

method called when user clicks on the new button Note: not yet supported for list view, BUT SUPPORTED for calendar view

noBgColor?: boolean

Mark that view/clip does not used the the background color even when it is loaded Use the noBgColor of clips on dashboards that has itseld target color - such portal will be totally collored

noDefButtons?: boolean

Mark not to show common buttons ok/save/cancel Currently supported only by client

noEnPrintOperation?: boolean

Optional mark that english verision is not available

noFilters?: boolean

options disable filters on the table header line. Use this option for tables that have only a few lines and user operates close to teh heading (typically list of few lines in the details)

Parameter

  • Removes the menu on the cell header
  • Limits options in the menu on on the select-column
  • blocks button to show more columns Default values is false - no limited scope

Field enabled and right are evaluated for command as well!!! They can be used to check where function should run or not. Evaluation used actual object status

operList?: string

Operations that results list of usable buttons Optional way how to dynamically defines buttons for view. Method could call both extensin in application as well as server List of buttons should be in the response from operation

principalObject?: string

Name of the view principal object

  • Used for clipLists and lists - it allows defined another object to be principal
  • Totally disregard by server

Example

for tskAreaTasks setup principal object is tskArea although it is stored in the tskTask object where several different list can share abstract set
printOperation?: string | boolean

Optional parameter setup default menu operation that call printing

  • If value is string it should return name of the counter (systemenum) with optional field to report
  • Value is evaluated iff starts by =
  • Value should contain or return valid name od the system enum in the from /
readonly?: string | boolean | string[]

All items are readonly and operations are disabled

  • for detail view evaluated with respect to the loaded object,
  • for list view evaluated with respect to the principal object - e.g. for list of area tasks in response to the area - however be carefull to check, if used parts of the principal objects are always loaded in context where list view is used
  • Can be list collected from readonly conditions inherited from ancestors

Example

sysRole might defined list of users withing its own list, Such view has principalObject = sysUser because there are users and not roles in the list

Not commonly used because such view should define everything internally becuase it cannot derive basic view data. The extensions of the principal view are preferred
reminders?: true

Mark that people can send reminders to someone else with the object. Creates new button in the button line

right?: string

Optinoal evaluated right for view. Makes the same as visible (later and allows defined independent conrols especially for clip)

Makes no sense and is not supported for list

rowEditable?: string

Optional parameters allow editing fields in the table. Each editable field should have attribute editable:true. If field has editable:... condition and parameter.rowEditable is also set, both values should be true

schedParams?: scheduleParams

Attributes withe field specific for tables with scheduling column

selfReadonly?: boolean

Mark that it uses its own readonly control. When true, parent detail does not control readonly status of the view

Example

see tskTask--reluser
singleOnly?: boolean

When set, user cannot set more than a single column. Equal to the open selection only for select single element

Used only for list parameters

snewButton?: boolean

When true, dialog offer Save & New button to save item and open detail for a new one

strangeRowIcon?: string

Name or function that returns icon for the first column of the strange column Used only in case that view does not return icon attributes

style?: any

optinal style for page container

Example for list (sysRole): "style":{ "placement":{"minHeight":"auto"}, // style for the placement of the list "listtable":{ "minHeight":"auto" } // style for div in which is located table }

subToList?: string | boolean

Makes sense only for list view opened as a subView When true and view is opened as a subview, listview creates special operation in the menu that allow opening list in the standalone tab/view when string it should be name of the list view used to open the list (e.g. "complete", not a full name)

tableOptions?: iDataTableOptions

Optionally filled fields for table settings

treeView?: string | boolean

Optional disable for tree-view; Almost definitevly makes actually nothing

userNotes?: boolean

Mark that view offers userNotes to the object - currently active only for detail

userSigns?: boolean

Mark that view supports showing / editing object marks when true view tries to show sings and works with them List accepts also string value: Signs are by default hidden if the clip is visible but can be forced by option userSigns=always

visible?: string

Optional attribute that can disable view even when user has global right to see it;

  • Use it for objects that are enables/disabled in according to some of their attributes (example: tskDefTask, tskTask)
  • Note: Setup list rights properly. When rights set correctly for list, user cannot even list objects which detail cannot open! It is safer and user won't see even data from the list
  • Make sense for views that are open as fast-view lookup from other details (look at the linked document)
  • Makes no sense and is not supported for list