Namespace: Consultingwerk.SmartFramework.Menu
Class 
MenuDatasetController Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implements: Consultingwerk.SmartComponents.Interfaces.IDatasetController

File:MenuDatasetController
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:11.10.2012 01:41:25
Notes:Conditionally implements the IDatasetController Interface
when the SmartComponentLibrary preprocessor option is set.



Top Method Summary
Options Name Purpose
+ LOGICAL ContainsClassFileNames (character[]) Verifies that the Character Array of file names contains a valid class naem
+ CreateFunctionsForClasses (character[]) Creates MenuFunction records for the passed in File Names
+ DeregisterConsumer (Object) Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter instances when detaching from the Dataset of the DatasetController. Allows event unsubscription etc.
+ CHARACTER GetFunctionGuidOfMenuItem (character) Get the FunctionGuid of a Menu Item identified by the MenuGuid
+ CHARACTER GetMenuNameFromMenuGuid (character) Get the MenuName of a Menu Item identified by the MenuGuid
+ RegisterConsumer (Object) Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter instances when attaching to the Dataset of the DatasetController. Allows event subscription etc.
+ ReorderItemsWithinLevel (Object) Brings up a Dialog to reorder the Nodes within the same level, populates the dialog and writes back changed data into the DB

Top Constructor Summary
Options Name Purpose
+ MenuDatasetController () Constructor of the MenuDatasetController class

Top Property Summary
Options Name Purpose
+ HANDLE DatasetHandle Returns the reference to the static dataset defined inside the Dataset Controller


Method Detail
Top

PUBLIC LOGICAL ContainsClassFileNames (character[])

Purpose: Verifies that the Character Array of file names contains a valid
class naem
Notes:

Parameters:
pcFileNames CHARACTER
An ABL Character Array of file names
Returns LOGICAL
Logical value indicating if the file names contain class names
Top

PUBLIC CreateFunctionsForClasses (character[])

Purpose: Creates MenuFunction records for the passed in File Names
Notes:

Parameters:
pcFileNames CHARACTER
An ABL Character Array of file names
Top

PUBLIC DeregisterConsumer (Object)

Purpose: Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter
instances when detaching from the Dataset of the DatasetController.
Allows event unsubscription etc.
Notes: Interface IDatasetController member

Parameters:
poConsumer Progress.Lang.Object
The reference of the Object detaching from the Dataset Controller
Top

PUBLIC CHARACTER GetFunctionGuidOfMenuItem (character)

Purpose: Get the FunctionGuid of a Menu Item identified by the MenuGuid
Notes:

Parameters:
pcMenuGuid CHARACTER
Id of a Menu entry
Returns CHARACTER
The FunctionGuid of the requested Menu Item. ? if not found.
Top

PUBLIC CHARACTER GetMenuNameFromMenuGuid (character)

Purpose: Get the MenuName of a Menu Item identified by the MenuGuid
Notes:

Parameters:
pcMenuGuid CHARACTER
Id of a Menu entry
Returns CHARACTER
The MenuName of the requested Menu Item. Blank if not found.
Top

PUBLIC RegisterConsumer (Object)

Purpose: Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter
instances when attaching to the Dataset of the DatasetController.
Allows event subscription etc.
Notes: Interface IDatasetController member

Parameters:
poConsumer Progress.Lang.Object
The reference of the Object attaching to the Dataset Controller
Top

PUBLIC ReorderItemsWithinLevel (Object)

Purpose: Brings up a Dialog to reorder the Nodes within the same level,
populates the dialog and writes back changed data into the DB
Notes:

Parameters:
poForm Progress.Lang.Object
The reference to the Form to parent the dialog to


Constructor Detail
Top

PUBLIC MenuDatasetController ()

Purpose: Constructor of the MenuDatasetController class
Notes: Assigns the DatasetHandle property



Property Detail
Top

PUBLIC HANDLE DatasetHandle

Purpose: Returns the reference to the static dataset defined inside the
Dataset Controller
Notes: Interface IDatasetController member

Returns HANDLE


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:37:07