Object blocks
Object block of the FORM statement adds objects (including object groups) to the form structure, as well as object trees to the interactive form view.
+Object blocks
Object blocks of the FORM statement - adding object groups to the form structure, and object trees to the interactive form view.
Object block
Syntax
OBJECTS groupDeclaration1 [groupOptions1], ...., groupDeclarationN [groupOptionsN]
SyntaxobjectDeclaration
objectDeclaration
Each objectDeclaration declaring an object has the following syntax:
[[name] [caption] =] classId [ON CHANGE actionId(param1, ..., paramM) | { actionOperator } ]
The declaration of each object group may be followed by a set of options called groupOptions:
viewType
INIT | FIXED
PAGESIZE pageSize
AFTER groupName
BEFORE groupName
defaultObjectsType
IN propertyGroup
EXTID extID
SUBREPORT [subReportExpression]
[[name] [caption] =] classId objectOptions
Object options objectOptions can be listed one after another in any order. The following set of options is supported:
ON CHANGE actionId(param1, ..., paramM)
ON CHANGE actionOperator
EXTID objectExtID
After the declaration of each object group, the group options groupOptions can be listed in any order:
viewType
insertPosition
defaultObjectsType
PAGESIZE pageSize
IN propertyGroup
EXTID extID
EXTKEY
SUBREPORT [subReportExpression]
BACKGROUND backgroundExpr
FOREGROUND foregroundExpr
Description
-A single OBJECTS block can contain several comma-delimited declarations of object groups. An object group can contain just one object or several ones. In case of a single object, you can use simplified syntax without specifying the name of an object group and using parentheses. The declaration of an object group may be followed by the options of this group. They are listed one after another in an arbitrary order.
A single OBJECTS block can contain several comma-delimited declarations of object groups. An object group can contain just one object or several ones. In case of a single object, you can use simplified syntax without specifying the name of an object group and using parentheses.
Parameters
-
@@ -53,9 +55,12 @@
Parameterscaption
Caption of the object being added. String literal. If the caption is not specified, the class caption will become the object caption.
+
Object options
+-
-
-ON CHANGE actionName(param1, ..., paramM) | { actionOperator }Specifying an action that will be called when the current object value is changed.
+
+ON CHANGE actionName(param1, ..., paramM)Specifying an action that will be called when the current value of the object changes.
-
@@ -63,72 +68,195 @@actionIDParameters
-param1, ..., paramMA list of object names on the form that will be used as action parameters. The number of these objects must be equal to the number of action parameters. The name of the object is defined with a simple ID.
+A list of object names on the form that will be used as action parameters. The number of these objects must be equal to the number of action parameters. The name of the object is defined with a simple ID.
+
-
-
+
+ON CHANGE actionOperatorCreating an action that will be called when the current value of the object changes.
+-
+
-
actionOperatorContext-dependent action operator. You can use the names of already declared objects on the form as parameters.
+ -
-
+
+EXTID objectExtIDSpecifying the name that will be used for export/import of this form object. Used only in the structured view.
+-
+
-
+
+objectExtIDString literal.
+
+
-
+
Object group options
-
-viewTypeDefault view for an object group. It is specified with one of the keywords:
+The default view for properties of this object group. Specified by one of the following ways:
-
-
PANEL- panel view.
-TOOLBAR- toolbar display mode.
-GRID- table column view;. Used by default.
+-
+
+PANELKeyword that, when specified, selects the panel view type
+
+ -
+
+TOOLBARKeyword that, when specified, selects the toolbar view type
+
+ -
+
+GRIDKeyword that, when specified, selects the table column view type. Used by default.
+
+ -
+
+PIVOT [pivotOptions]When the
+PIVOTkeyword is specified, the pivot table view type is selected. Options for this view typepivotOptionscan be specified one after another in any order.-
+
-
+
+pivotTypeString literal that defines the initial display mode of the pivot table. Can be equal to one of the following values:
+-
+
'Table'(default value)
+'Table Bar Chart'
+'Table Heatmap'
+'Table Row Heatmap'
+'Table Col Heatmap'
+'Bar Chart'
+'Stacked Bar Chart'
+'Line Chart'
+'Area Chart'
+'Scatter Chart'
+'Multiple Pie Chart'
+'Horizontal Bar Chart'
+'Horizontal Stacked Bar Chart'
-
-
-PAGESIZE pageSizeSpecification of the number of readable objects in the table. By default, the quantity is determined dynamically depending on the size of the component in the user interface and equals to
+3 * <number of visible rows in the table>. A value of0means that all objects must be read.
+calcTypeSpecifying the initial aggregation function. It can be set using one of the keywords:
-
+
SUM- sum of values (default value)
+MAX- maximum of values
+MIN- minimum of values
+
-
-
-pageSizeNumber of objects read. Integer literal.
+
+settingsTypeSpecifying whether the pivot table settings are shown to the user. It can be specified by one of the keywords:
+-
+
SETTINGS- settings are shown (default value)
+NOSETTINGS- settings are not shown
+
+
+ -
+
-
+
+MAP [tileProvider]When the
+MAPkeyword is specified, the map view type is selected. By default, this view uses OpenStreetMap maps. It is possible to use Google or Yandex maps. To do this you need to include theGeo.lsfmodule in the project, then obtain an API key for Google or Yandex and specify it inAdministration > Application > Settings > Navigation.-
+
-
+
+tileProviderString literal that specifies the map source. Possible options:
+'google'and'yandex'. If not specified, OpenStreetMap will be used as the map source.
+
+ -
+
-
+
+CALENDARKeyword that, when specified, selects the calendar view type.
+
+ -
+
+CUSTOM renderFunction [HEADER expr]When the
+CUSTOMkeyword is specified, the custom view type is selected.-
+
-
+
+renderFunctionA string literal specifying the name of the JavaScript function that is responsible for displaying the data. This function must be located in a .js file included in the project resources and loaded for use on the client. It should return a JavaScript object that contains three functions:
+-
+
render(element, controller)
+update(element, controller, list, options)
+clear(element)(optional)
+
A more detailed description of the mechanism can be found in the article How-to: Custom Components (Objects).
+
+ -
+
+exprExpression whose value must be an object of the JSON class. It is used to pass data that does not depend on the values of the described object group.
+ -
+
+
-
-
+AFTERgroupName
+insertPositionSpecifying the insertion position of the object group within the list of object groups. Most often used together with the form extension mechanism. It can be specified in one of the following ways:
+-
+
-
+
AFTER groupName -
-
-BEFOREgroupNameSpecifying that the object tree should be added to the form structure immediately before (keyword
+BEFORE) or after (keywordAFTER) of a specified object group. Typically used with the form extension mechanism . If a group is added before the group in a tree, then this group should the first in this tree. Accordingly, if a group is added after the group in a tree, this group should be the last in this tree.
+BEFORE groupNameThe object group will be added to the form structure directly before (keyword
BEFORE) or after (keywordAFTER) the specified object group. If the group before (after) which it is to be added is in the tree, it must be the first (last) in that tree.-
- +groupNameObject group name. Simple ID.
+
+
+ -
-
+
+FIRSTKeyword indicating that the object group will be added to the beginning of the list.
+
+ -
+
+LASTKeyword indicating that the object group will be added to the end of the list.
+
+ -
+
+DEFAULTKeyword indicating that the object group is added in the order of declaration. This is the default value.
-
+
-
-defaultObjectsTypeSpecifying which object collection from the added object group will be current after the change of the active filters:
+Specifying which object collection from the added object group will be current after the active filters are changed. Specified by one of the keywords:
-
-
FIRST– specifies that the first object collection will be the default objects
-LAST- last one
-PREV- previous one
+FIRST– specifies that the first object collection (according to the current order) will be the default objects
+LAST- last object collection
+PREV- the previous (or closest possible) object collection
+NULL- none (reset)
If this option is not specified, the platform determines the option to be used depending on the current filters.
-
+
+PAGESIZE pageSizeSpecification of the number of readable objects in the table. By default, the quantity is determined dynamically depending on the size of the component in the user interface and equals to
+3 * <number of visible rows in the table>. A value of0means that all objects must be read.-
+
-
+
+pageSizeNumber of objects read. Integer literal.
+
+
+ -
+
-
-IN propertyGroupSpecifying the property/action group that the object group belongs to. Used only in the hierarchical view.
+Specifying the property and action group that the object group belongs to. Used only in the hierarchical view.
-
-propertyGroupThe property group name. Composite ID.
+The property and action group name. Composite ID.
-
-
-EXTID extIDSpecifying the name to be used for export/import operations performed by this object group. Used only in the structured view.
+Specifying the name to be used for export/import of this object group. Used only in the structured view.
-
@@ -137,6 +265,10 @@extIdObject
-
-
+
+EXTKEYWhen keyword
+EXTKEYis specified the values of objects and properties of this object group are represented in a structured view as key-value pairs, where the key is the value of the object (set of objects) and the value is the property values. By default, they are represented as an array with lists of property values.
+ -
SUBREPORT [subReportExpression]Specifies that you need to generate a separate report file for this object group while building the report hierarchy.
-
@@ -146,18 +278,36 @@
Object
BACKGROUND backgroundExpr
Specifying the background color of property cells belonging to this object group.
+-
+
-
+
+backgroundExprExpression whose value determines the background color.
+
+
FOREGROUND foregroundExpr
Specifying the foreground color of property cells belonging to this object group.
+-
+
-
+
+foregroundExprExpression whose value determines the foreground color.
+
+
Examples
CLASS Shipment;
// declaring the delivery form
FORM shipments 'Deliveries'
OBJECTS s = Shipment // adding one object of the shipment class
PAGESIZE 100 // indicating that the table should always contain 100 rows
// ... adding properties and filters to the form
;
// Declaring a form that will display the turnover of the product for a specified interval
name = DATA STRING[100] (Item);
revenue = DATA NUMERIC[16,2] (Item, DATE, DATE);
FORM revenues 'Product turnovers'
// declaring a group of objects, consisting of 2 objects of the Date class with the appropriate captions,
// which will always be displayed as a panel
OBJECTS interval = (dateFrom 'Date (from)' = DATE, dateTo 'Date (to)' = DATE) PANEL,
i = Item // adding a list of products
// adding to the form the properties of the date objects values, with which the user can select dates
PROPERTIES VALUE(dateFrom), VALUE(dateTo)
// adding the product name and the property with the product turnover for the date interval
PROPERTIES name(i), revenue(i, dateFrom, dateTo)
;
// creating a form for printing a price tag for a product
labelFile = DATA STRING[100] (Item);
printLabelFile (Item i)= OVERRIDE labelFile(i), 'MyModule_printLabel_i.jrxml' IF i IS Item;
FORM printLabel 'Price tag printing'
OBJECTS i = Item // adding the product for which the price tag will be printed
// marking that a file whose name is stored in the printLabelFile property should be used as a template
// (it is assumed that the i value will be passed in the OBJECTS block)
REPORT printLabelFile(i)
// for example, the user can input myLabel1.jrxml there, then the system will use a file named myLabel1.jrxml
// ... other properties required for printing
;
Object tree block
Syntax
-TREE [name] groupDeclaration1 [parentBlock1], ...., groupDeclarationN [parentBlockN] [treeOptions]
Each groupDeclaration is a declaration of an object group that is similar to the declaration in an object block described above. Each parentBlock can be described in one of the following ways:
PARENT propertyId
(PARENT propertyId1, ..., propertyIdK)
TREE [name] groupDeclaration1 [parentBlock1], ...., groupDeclarationN [parentBlockN] [insertPosition]
Each groupDeclaration is a declaration of an object group that is fully analogous to the declaration in the object block described above. Each parentBlock can be described in one of two ways:
PARENT parentExpr
(PARENT parentExpr1, ..., parentExprK)
The first option is used if an object group for which the block is specified consists of a single object, the second one is used for groups of two and more objects.
-The treeOptions options set may be specified after the declaration of each object tree.
AFTER groupName
BEFORE groupName
Description
Object tree block lets you create an object tree. The first specified object group will form a list of top-level objects, each of which will have a child list of objects of the second specified object group and so on.
Use the PARENT block to create hierarchical object groups. To do that, specify a property that will define the parent element for an object (or several objects if an object group contains several ones).
ParametersThe name of the object tree being created. Simple ID.
propertyId
ID of the property defining the hierarchy for an object group consisting of a single object. The specified property must have a single parameter and return the parent object of the passed object as its value (or NULL if the passed object is the top one).
propertyId1, ..., propertyIdK
A list of property ID's defining the hierarchy for an object group consisting of several objects. All specified properties must have the same number of parameters as the number of objects in the object group. Each of these properties must return one of the parent objects of the passed objects as a value (or NULL if the passed object collection is the top one). The first property should return the first parent object, the second property - the second object, etc. on.
Object tree options
--
-
-
-
+AFTER groupName
+parentExprExpression that defines a hierarchy for a group of objects consisting of a single object. This expression must create a property that has exactly one parameter and returns the parent object for the object passed as input (or
NULLif the passed object is at the top level). -
-
-BEFORE groupNameSpecifying that the object tree should be added to the form structure immediately before (keyword
+BEFORE) or after (keywordAFTER) of a specified object group. Typically used with the form extension mechanism . If a group is added before the group in a tree, then this group should the first in this tree. Accordingly, if a group is added after the group in a tree, this group should be the last in this tree.
+parentExpr1, ..., parentExprKA list of expressions that define a hierarchy for an object group consisting of multiple objects. These expressions should create properties with a number of parameters equal to the number of objects in the group. Each of these properties should return one of the parent objects for the object collection passed as input (or
NULLif the passed object collection is at the top level). The first property should return the first object of the parent object collection, the second property - the second object, and so on. -
-
- +groupName
+insertPositionSpecifying the insertion position of tree object groups in the list of object groups. It has syntax fully analogous to the same option in the object block.
Examples
-CLASS SkuGroup;
name = DATA ISTRING[100] (SkuGroup);
active = DATA BOOLEAN (SkuGroup);
parent = DATA SkuGroup (SkuGroup) AUTOSET;
CLASS Sku;
name = DATA ISTRING[100] (Sku);
skuGroup = DATA SkuGroup (Sku);
FORM skus 'Sku'
TREE groupTree g=SkuGroup PARENT parent(g)
PROPERTIES READONLY name(g)
FILTERS active(g)
OBJECTS s = Sku
PROPERTIES(s) name
FILTERS skuGroup(s) == g
;
CLASS Group1;
name = DATA STRING[100] (Group1);
CLASS Group2;
name = DATA STRING[100] (Group2);
CLASS Group3;
name = DATA STRING[100] (Group3);
in = DATA BOOLEAN (Group1, Group2);
in = DATA BOOLEAN (Group2, Group3);
FORM groups
TREE groups g1 = Group1, g2 = Group2, g3 = Group3
PROPERTIES READONLY name(g1), name(g2), name(g3)
FILTERS in(g1, g2), in(g2, g3)
;
CLASS SkuGroup;
name = DATA ISTRING[100] (SkuGroup);
active = DATA BOOLEAN (SkuGroup);
parent = DATA SkuGroup (SkuGroup) AUTOSET;
CLASS Sku;
name = DATA ISTRING[100] (Sku);
skuGroup = DATA SkuGroup (Sku);
FORM skus 'Sku'
TREE groupTree g=SkuGroup PARENT parent(g)
PROPERTIES READONLY name(g)
FILTERS active(g)
OBJECTS s = Sku
PROPERTIES(s) name
FILTERS skuGroup(s) == g
;
CLASS Group1;
name = DATA STRING[100] (Group1);
CLASS Group2;
name = DATA STRING[100] (Group2);
CLASS Group3;
name = DATA STRING[100] (Group3);
in = DATA BOOLEAN (Group1, Group2);
in = DATA BOOLEAN (Group2, Group3);
FORM groups
TREE groups g1 = Group1, g2 = Group2, g3 = Group3
PROPERTIES READONLY name(g1), name(g2), name(g3)
FILTERS in(g1, g2), in(g2, g3)
;