Interface viewClipDescription

Definition of the clip

interface viewClipDescription {
    active?: string | object;
    afterSave?: string | string[];
    attributes: iviewAttribute[];
    bOrderPrefix?: string;
    boxes?: iViewBoxList;
    buttons?: string[] | iButtonList;
    childClip?: string;
    childern: string | string[];
    defOperation?: string;
    extends: string;
    filters?: ifilterList;
    groups: string[];
    help?: string | boolean;
    hint?: string;
    infoIcons: string | object;
    leftBlock?: string | object;
    listObjMethods?: object;
    menu?: string[];
    methods?: object;
    onLoad?: string | string[];
    onSave?: string | string[];
    operations?: iOperList;
    pageButtons?: string[];
    parameters?: iviewParameters;
    passive?: string | object;
    serverData?: iserverData;
    style?: ClipItemsStyles;
    subtitle?: string;
    tabs?: iViewTabList;
    title: string | boolean;
    titleButtons?: string[];
    titleData?: string[];
    titleNew?: string;
    type: viewClipType;
    update?: string;
    uright?: string;
    window?: viewWindowDescription;
}

Hierarchy (view full)

Properties

active? afterSave? attributes bOrderPrefix? boxes? buttons? childClip? childern defOperation? extends filters? groups help? hint? infoIcons leftBlock? listObjMethods? menu? methods? onLoad? onSave? operations? pageButtons? parameters? passive? serverData? style? subtitle? tabs? title titleButtons? titleData? titleNew? type update? uright? window?

Properties

Optional active

active?: string | object

Content of the view when view is active, typically json for evaluation

Optional afterSave

afterSave?: string | string[]

Optional function called in detail view after the save command regardless if object was/wasn't new. Allow startings other operation in reaction to the save

Example

tskArea initiate reload of the dashboard

attributes

attributes: iviewAttribute[]

Definition of object-defined user-attributes Defined by client of their objects

Optional bOrderPrefix

bOrderPrefix?: string

Optinonal prefix used for ordering all buttons in the view Use the prefix in combination with button names in array - then order of all of are prefixed with defined

Optional boxes

boxes?: iViewBoxList

boxes defeind in the detail

Optional buttons

buttons?: string[] | iButtonList

Names of operations in the list of strings - converted to the _operNames;
only string with name, operation is described in its own section

Optional childClip

childClip?: string

link to the child clip can contain:

  • clipID in the form (objectName.clipType.clipName)

Example

sysUser.clip.default
* evalopenDashboarduation that has got all data from select

Example

=

Obj Type

== 'user' ? 'sysUser.clip.default' :

Obj Type

== 'role' ? 'sysRole.clip.default' : ''

When not defined in the clipList, default value is this.clip.default

Attributes: Clip that is simply defined and not evaluated (e.g. default) has got attributes from parent (startAttrs are inherited) - it can use attributes like isManager (aka "right":"=attr.isManager") BUT childClip that is evaluated (with = at the beginning) does not get automatically parent attributes and must copy manually those that are needed, =this.clip....(isManager=attr.isManager) - this make sense for evaluated clip!!!

childern

childern: string | string[]

Optional clips that are loaded as childern of this clip

  • Note: Intended to create tree structure from clips,

Example

"childern":"sysArea.clipList.--subareas"
* List is also allwoed:

Example

"childern": {"sysArea.clipList.--subareas", "sysTask.clipList.--areasubtasks"}

Optional defOperation

defOperation?: string

Optinal name of the default operation that is activated when uses clicks on the active clip Note: supported only for clip for listClip it is expand/collapse

extends

extends: string

Name of the view that is used as a base for this view - allows inherit view defition parent view must be described in the same object definition file and should be of the same view type (list or detail)

Optional filters

filters?: ifilterList

groups

groups: string[]

List of optional object groups - defines functionality related with some groups

Example

see objGroups type that defines standard supported types

Optional help

help?: string | boolean

Set up if view has to show the help button next to the name

Options are:

  • (boolean) true - show help if defined for object (default)
  • (boolean) false - do not show help event when defined for object
  • string - name of the help for this view - should be valid name of the MD file in the /module/langs/@/ directory

Notes:

  • subviews has not visible header and thus does not support help file at all
  • clipList support the help but the clip detail does not, clip disregard the parameter, clipList supports only clip-specific help, not common
  • dashboard supports clips but only clip-specific (help should be a string; boolean value is ignored and help si not available)

Optional hint

hint?: string

Optional hint - text under the command line (or filter line in the list) hint is:

  • invisible - not defined
  • text only - always translated (name of the string for translation)
  • evaluated - return is translated string - result of evaluation is not translated
  • from caller - content of the hint parameter i showns (not translated!)

infoIcons

infoIcons: string | object

Field of info icons in the clip corner, valid both for list clip and single clip

Optional leftBlock

leftBlock?: string | object

Always visible content left from active / passive Intedned for object image or similar square content not supported with icons left/right, only for icont topLeft/topRigth

Optional listObjMethods

listObjMethods?: object

Methods for objects in the list. Used as a object-specific methods for object in the list (list only)

Optional menu

menu?: string[]

Optional methods

methods?: object

methods relative to the view; see object methdos for description. View methods are evaluated for view only and AFTER the object methods. Object methods can never use them

For ClipList: Methods are evaluated with startAttr and parentObject and set attributes - never change the parentObject. Use methods for setting attributes that are passed to the child clip. Child cannot get data from parent object but has got attributes @example: tskCompetenceDemand: "methods":{ "isManager":"=obj.isManager" }, - it sets attribute value in the clipList (and list)

WARNING: Methods are evaluated also for listView with several limitations:

  • They are eavluatated during window open with obj from mater view - METHODS IN THE LIST NEVER UPDATE OBJECT - result of list method is stored to the attributes
  • When storing new value for work with, use store to the attributes:

Example

attr._a.addVal(<attributeName>, <attributeValue>)   (not necessary in the list and clipLst methods that sets attributes directly)

Optional onLoad

onLoad?: string | string[]

Optional operation called after load is provided.

  • field should be operation from operations
  • called after default attributes for new field
  • user enabled to set if called before
  • command->env->myself contains link to the fieldset

Optional onSave

onSave?: string | string[]

Optional operation called before save is provided. If returns false, save is not called

  • field should be operation from operations
  • for each operation is evaluated enabled field and if returns with false operation is overskipped and next operation is processed. enabled that returns false is managed in the same way as function that returns false; it can never return cancel if evalution fails with error it is recorded as error (by the feval) and considered as false return
  • operations in the list do not share attributes
  • if operation calls TS method, it gets in evn->myself link to the fieldset, in evn->fbase link to the univDetail
  • called after beforeSaveControls
  • command->env->myself contains link to the fieldset

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

Optional operations

operations?: iOperList

Operations defined for view - visible only in view and its descendant. See object operations for more description

Optional pageButtons

pageButtons?: string[]

Operations available in the bottomline

Currently supported only for detail, not list; makes no sense for clips

Optional parameters

parameters?: iviewParameters

Optional passive

passive?: string | object

content of the view when is no active; not required, if the same with active

Optional serverData

serverData?: iserverData

Optional style

style?: ClipItemsStyles

Optional subtitle

subtitle?: string

Options that page subtitle content.

  • If defined it is evaluated with loaded object
  • Suppported currently only by detail

Optional tabs

tabs?: iViewTabList

title

title: string | boolean

Headline - independent first line or content

  • clip required, when missing empty line is created, if user is develper, line contains warning that is not generated for no-developer user
  • clipList - not required and even not recommended for list that are part of detail; only string supported for clipList!
  • list
      • when boolean = false list is without title - used for views under the view
      • when true = list is with title even when undder the detail (detail is false)
  • detail
      • when false view is without title
      • when string view is evaluated to calculate value - almost always useless, use objDesc field for that
  • when title == false, clip title is not shown - supported for clipList, makes no sense for detail

Optional titleButtons

titleButtons?: string[]

Operation right from the clipList title For detail tested with icon on the left or without icon

Optional titleData

titleData?: string[]

List of datafields - small information one after another, Technically buttons supporting click but also usable wihout click Each Field is single operation and operation name is used for content description - title shall describe what is inside

Optional titleNew

titleNew?: string

Optional title used for new object. By default, new object has name from translation of the object but it may be usefull to change it. Remmber, that new window does not have data from object

type

type: viewClipType

type how to to load list data

  • id: select to load list contains id field only; child clips loads ale their data themself.
  • data: (default option): child gets all row data from the list liad; and is expected to draw the content from data loaded at once for all childern. Recommended since it uses only a single request for all clips in the list

Remeber: Clips loaded by the list using data load type still needs select to reload themself if they support some information and request reload afther the operation return

Optional update

update?: string

name of the function that is called with updated data. Makes sense only for editable clips

Optional uright

uright?: string

optional right for view used instead of default; works for all views inluding clips

Optional window

window?: viewWindowDescription

how window should look

Settings

Member Visibility

Theme

On This Page

activeafterSaveattributesbOrderPrefixboxesbuttonschildClipchilderndefOperationextendsfiltersgroupshelphintinfoIconsleftBlocklistObjMethodsmenumethodsonLoadonSaveoperationspageButtonsparameterspassiveserverDatastylesubtitletabstitletitleButtonstitleDatatitleNewtypeupdateurightwindow