Namespace: Consultingwerk.Web2.Services.SmartViews
Class 
Viewer Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:Viewer
Purpose:Returns the html fragment for a html viewer of
SmartComponents.Web2
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jul 18 11:04:20 CEST 2015
Notes:Supports Business Entity Descriptor defined views:
"Consultingwerk.SmartComponentsDemo.OERA.Sports2000.CustomerBusinessEntity#customer"
Supports custom log entry type "FieldSecurity"
Purpose: Constructor for the Viewer class
Notes:



Top Method Summary
Options Name Purpose
+ LONGCHAR GenerateViewer (IBusinessEntityDescriptor, character, character, handle, character, character, ViewerBindingStyleEnum, logical, character) Generates the Viewer hmtl code
+ Progress.Json.ObjectModel.JsonObject GenerateViewerJson (IBusinessEntityDescriptor, character, handle, character, character, logical, character) Generates the Viewer JSON code
+ Progress.Json.ObjectModel.JsonObject GetFragment (character, character) Returns the HTML Fragment for the SmartViewer

Top Constructor Summary
Options Name Purpose
+ Viewer () Constructor for the Viewer class


Method Detail
Top

PUBLIC LONGCHAR GenerateViewer (IBusinessEntityDescriptor, character, character, handle, character, character, ViewerBindingStyleEnum, logical, character)

Purpose: Generates the Viewer hmtl code
Notes:

Parameters:
poBusinessEntityDescriptor Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor
The reference to the Business Entity Descriptor of the Business Entity
pcEntityTable CHARACTER
The name of the Entity Table (first table)
pcScope CHARACTER
The scope to bind the UI controls to (including the .selected portion if required)
phDataset HANDLE
The handle of the Business Entity Dataset
pcTables CHARACTER
The list of tables (entity table + entity view)
pcViewerColumns CHARACTER
The list of columns to generate in the viewer
poBindingStyle Consultingwerk.Web2.Services.SmartViews.ViewerBindingStyleEnum
The style of data bindings (AngularJS or Angular2)
plPerformSecurityCheck LOGICAL
Logical value indicating if the method should perform field level security checks (hidden, read-only)
pcSecurityKey CHARACTER
The security key
Returns LONGCHAR
The html code
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GenerateViewerJson (IBusinessEntityDescriptor, character, handle, character, character, logical, character)

Purpose: Generates the Viewer JSON code
Notes: Only supports the JSON Markup used by the SmartComponents NG2

Parameters:
poBusinessEntityDescriptor Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor
The reference to the Business Entity Descriptor of the Business Entity
pcEntityTable CHARACTER
The name of the Entity Table (first table)
phDataset HANDLE
The handle of the Business Entity Dataset
pcTables CHARACTER
The list of tables (entity table + entity view)
pcViewerColumns CHARACTER
The list of columns to generate in the viewer
plPerformSecurityCheck LOGICAL
Logical value indicating if the method should perform field level security checks (hidden, read-only)
pcSecurityKey CHARACTER
The security key
Returns Progress.Json.ObjectModel.JsonObject
The JSON object with the viewer markup
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetFragment (character, character)

Purpose: Returns the HTML Fragment for the SmartViewer
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity to return a view spec form
pcViewName CHARACTER
The name of the view
Returns Progress.Json.ObjectModel.JsonObject
The JSON Markup of the Viewer


Constructor Detail
Top

PUBLIC Viewer ()

Purpose: Constructor for the Viewer class
Notes:



©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:24:38