IRISLIB database
TreeUtils Class Reference

This class contains methods that can be used to construct common tree structures for use with the <class>ZEN.Component.dynaTree</class> component. More...

Inheritance diagram for TreeUtils:
Collaboration diagram for TreeUtils:

Static Public Member Functions

_.Library.Status ClassTree (_.Library.String pRoot, pTree, pParms)
 Create a tree based on the packages and classes visible in the. More...
 
_.Library.Status PropertyTree (_.Library.String pRoot, pTree, pParms)
 Return the set of properties within a given class.
 
_.Library.Status TimePeriodTree (_.Library.String pRoot, pTree, pParms, _.Library.Integer pTopNode)
 Create a tree containing time periods. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

This class contains methods that can be used to construct common tree structures for use with the <class>ZEN.Component.dynaTree</class> component.

Member Function Documentation

◆ ClassTree()

_.Library.Status ClassTree ( _.Library.String  pRoot,
  pTree,
  pParms 
)
static

Create a tree based on the packages and classes visible in the.

current namespace.
Each node has a value with a ".pkg" or ".cls" suffix.
pRoot is "" when called for the top-level. Otherwise it contains the package name of the parent node.
pParms can contain the following:
pParms("system") = 0 | 1 control whether % items are displayed.

◆ TimePeriodTree()

_.Library.Status TimePeriodTree ( _.Library.String  pRoot,
  pTree,
  pParms,
_.Library.Integer  pTopNode 
)
static

Create a tree containing time periods.


The contents of the tree are specified by values within the pParms array:
pParms("spec") - A comma-delimited list that controls the hierarchy of time periods. This can contain Y(ear), Q(uarter), M(onth), W(eek), D(ay). For example: "Y,Q,M" will show years, quarters, and months.
The time period of the tree can be controlled using:
pParms("startYear") - starting year for year periods (default is current year)
pParms("endYear") - end year for year periods (default is startYear)
pParms("startMonth") - starting month (1-12) for month periods (default is 1)
pParms("endMonth") - ending month (1-12) for month periods (default is 12)
pParms("startQuarter") - starting quarter (1-4) for quarter periods (default is 1)
pParms("endQuarter") - ending quarter (1-4) for quarter periods (default is 4)
pParms("startWeek") - starting week (1-52) for week periods (default is 1)
pParms("endWeek") - ending week (1-52) for week periods (default is 52)
pParms("startDay") - starting day for day periods (default is 1)
pParms("endDay") - ending day for day periods. Interpretation of this value depends on how days are displayed (yearly, weekly, etc.)

When years are not displayed, the startYear is used to provide the year portion of date values.
The logical value of nodes an indicator followed ODBC format date:
"Y 2007", "M 2007-03", etc.
For weeks and quarters the starting month or day of the period is used.
Weeks are not supported at this time.