Consultingwerk.BusinessEntityDesigner.KendoUiBuilder.ViewGenerator

Namespace:

Consultingwerk.BusinessEntityDesigner.KendoUiBuilder

Class

ViewGenerator

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.KendoUiBuilder.ViewGenerator

Inherits:

Progress.Lang.Object

File:	ViewGenerator
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Sun Oct 02 19:15:33 CEST 2016
	/* Mike Fechner, Consultingwerk Ltd. 13.09.2017
	Preprocessor variables for SmartComponentLibrary, WinKit and SmartFramework
	based on Consultingwerk/packages.i now

Top Method Summary

Options	Name	Purpose
#	AddSerializedTypeInformation (JsonObject)	Adds the Serialized Type Information to the nodes of the Json Object
+	CHARACTER BuildFileName (character, character)	Returns the file name the generator is writing to
+	CreateView (Module, dataset, character, character, character, character, character, CharacterList, ListViewerFieldSpec)	Creates a view with the provided specifications to the module
+	CHARACTER GetModuleNames (character)	Returns an array of the view names
+	LOGICAL HasView (Module, character)	Returns if the provided Module contains a view with the given Name
+	Consultingwerk.Web.KendoUiBuilder.Module.Module LoadModule (character, character)	Loads the given module
+	LOGICAL ModuleExists (character, character)
+	RemoveView (Module, character)	Removes the view with the given name from the module
+	SaveModule (Module, character, character)	Saves the module definition

Top Constructor Summary

	Options	Name	Purpose
	+	ViewGenerator ()	Constructor for the ViewGenerator class
	+	ViewGenerator (character, character)	Constructor for the ViewGenerator class

Top Property Summary

	Options	Name	Purpose
	+	CHARACTER AppLocation
	+	CHARACTER ModuleName

Method Detail

Top

PROTECTED AddSerializedTypeInformation (JsonObject)

Purpose:	Adds the Serialized Type Information to the
	nodes of the Json Object
Notes:

Parameters:
poJsonObject	Progress.Json.ObjectModel.JsonObject
	The JSON object to process

Top

PUBLIC CHARACTER BuildFileName (character, character)

Purpose:	Returns the file name the generator is writing to
Notes:

Parameters:
pcModuleName	CHARACTER
	The name of the Module to generate
pcAppLocation	CHARACTER
	The folder of the Kendo UI Builder builder project
Returns	CHARACTER
	The file name

Top

PUBLIC CreateView (Module, dataset, character, character, character, character, character, CharacterList, ListViewerFieldSpec)

Purpose:	Creates a view with the provided specifications to the module
Notes:	Launches the specific view generator instance

Parameters:
poModule	Consultingwerk.Web.KendoUiBuilder.Module.Module
	The module to add the new view to
dsBusinessEntity	DATASET dsBusinessEntity
	The dataset with the Business Entity Model
pcTables	CHARACTER
	The entity table and view tables
pcViewType	CHARACTER
	The type of the view to create
pcViewName	CHARACTER
	The name of the view to create
pcDataProvider	CHARACTER
	The name of the data provider
pcDataSource	CHARACTER
	The name of the data source
poGridColumns	Consultingwerk.Framework.Collections.CharacterList
	The CharacterList with the column names to use for the grid
poViewerFields	Consultingwerk.BusinessEntityDesigner.Generator.Viewer.ListViewerFieldSpec
	The list with the viewer field specs

Top

PUBLIC CHARACTER GetModuleNames (character)

Purpose:	Returns an array of the view names
Notes:

Parameters:
pcAppLocation	CHARACTER
	The folder of the Kendo UI Builder builder project
Returns	CHARACTER
	The ABL Character Array of Module Names

Top

PUBLIC LOGICAL HasView (Module, character)

Purpose:	Returns if the provided Module contains a view
	with the given Name
Notes:

Parameters:
poModule	Consultingwerk.Web.KendoUiBuilder.Module.Module
	The Module
pcViewName	CHARACTER
	The name of the View
Returns	LOGICAL
	Logical value determing if the module contains the view

Top

PUBLIC Consultingwerk.Web.KendoUiBuilder.Module.Module LoadModule (character, character)

Purpose:	Loads the given module
Notes:

Parameters:
pcModuleName	CHARACTER
	The name of the Module to Load
pcAppLocation	CHARACTER
	The folder of the Kendo UI Builder builder project
Returns	Consultingwerk.Web.KendoUiBuilder.Module.Module
	The Module definition

Top

PUBLIC LOGICAL ModuleExists (character, character)

Purpose:
Notes:

Parameters:
pcModuleName	CHARACTER
	The name of the Module to Load
pcAppLocation	CHARACTER
	The folder of the Kendo UI Builder builder project
Returns	LOGICAL

Top

PUBLIC RemoveView (Module, character)

Purpose:	Removes the view with the given name from the module
Notes:	Does not throw any error when the View does not exist

Parameters:
poModule	Consultingwerk.Web.KendoUiBuilder.Module.Module
	The Module
pcViewName	CHARACTER
	The name of the View

Top

PUBLIC SaveModule (Module, character, character)

Purpose:	Saves the module definition
Notes:

Parameters:
poModule	Consultingwerk.Web.KendoUiBuilder.Module.Module
	The Module definition
pcModuleName	CHARACTER
	The name of the Module to Load
pcAppLocation	CHARACTER
	The folder of the Kendo UI Builder builder project