Additional information about the object

interface iObjectAbout {
    _translation?: string;
    allowSupper: boolean;
    autoLoad?: string[];
    classID: string;
    css: string;
    devStatus?: iDevStatus;
    drag?: string | boolean;
    drop?: string;
    dropAccepted?: boolean | string[];
    dynamicIcon?: string;
    extends?: string;
    groups?: objGroups[];
    help?: string;
    icon: string;
    langModules: string[];
    moduleCondition?: string;
    name: string;
    objDesc: string;
    objRight: string;
    objTooltip: string;
    offline?: string;
    selfDashboard?: string;
    selfDetail?: string;
    type: frmobjectType;
    version?: number;
}

Properties

_translation?: string
allowSupper: boolean
autoLoad?: string[]

List of objects that should be loaded for correct operation of the object @example: amAbsractAsset list is called to show list of all descendants but the descendats should also be loaded becacuse without them field in the list are not presented correctly

classID: string
css: string
devStatus?: iDevStatus

Distinguishes between stable object and objects under the development. Stable objects do no report information to the console When value is not used stable state is expected

drag?: string | boolean

Condition when view allows drag operation; Supported for types of views

  • Condition is support both for whole object as well as for a single view, View has preference
  • Supported onlby by table, clip and cliplist, not by detail

Condition return values:

  • value true - drag / false - no drag
  • object - dragobject handler: @example: "drag":"={oName:'sysUser', oID:obj.subjectID , objDesc:${obj.roleName}:${obj.subjectIDDesc}}"
drop?: string

Mark hwo to manage drag

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

  • Remember that string does not defined if object accept
  • dragged object generally - that is defined by dropAccpeted list in the object head
  • When value is 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

@example: "drop":"={oName:'sysUser', oID:obj.subjectID , objDesc:${obj.roleName}:${obj.subjectIDDesc}}"

dynamicIcon?: string

Dynamically defined icon used if icon variant could be set by object data. Used in dashboards and details (if exists)

extends?: string
groups?: objGroups[]

List of object groups

help?: string

Optional name of the help file Used the name only in case that is necessary to use non-default name. Default name is the name of the object. It is recommneded not to use them for abstract object due to the file sorting in documentation

icon: string

Name of the icon from the module-loaded icons. Use name only for default object icon

langModules: string[]
moduleCondition?: string

Condition of the module paramaters that user should have to use the condition. Condition is not fval only single string from module xxxOptions stored in the client settings Client get form server only objects that conditions are set Condition will be later used by server as well!

name: string
objDesc: string

string describing, how to get single object description, typicaly someting like {@name } : {@status } @objectName, string should contain only object fields or

Object Name

that is translated

objRight: string

Default object right is valid in case that uright for view or operation is not defined or if those has no -- prefix

  • objRight should always be without module. SO that the right cannot from another module.
  • objRight is always single string, never stringlist. (Only a single right is allowed)
  • objRight is has always lower priority than uright at the view/operation level. If uright is defined it is used exclusively and the object right is disregarded.
  • If neither objRight nor operation uright is used, object should have module in the tableSQL and module in the path equal, otherwise rights won't work.

Example

objRight = "sysAction:use"
objTooltip: string

evaluated string that generates the object description used as a tooltip in the clip

offline?: string

optional condition when the object is stored offine. Condition is evaluated without attributes and without lang. Only obj object can be used for condition (and static objects g, user) Always evaluated, boolean value is not expected. For objects that are online only don't use the attribute (howeber offline:false works correctly)

selfDashboard?: string

The same as selfDetail but used in case of dashboard

selfDetail?: string

Optional name of the detail used for self detail instead of default. Evaluated in the list or clip when selfDetail or selfModal detail is used - can be used to used correct detail even in the case of list-detail view

version?: number

Optional number of the model json model file version v2:

  • attribute without box is by default invisible