NJX:XCIWPINFO2

The NJX:XCIWPINFO2 control is used to access and exchange the function tree that is shown in the "Functions" frame (MFWPFUNCTIONS) as a whole. In order to perform incremental changes in the function tree, you should use the NJX:XCIWPFUNCTIONS control.

The NJX:XCIWPINFO2 control provides a functional API to the workplace. It does not have design time properties nor does it raise events.

The following topics are covered below:

Example
Adapter Interface

Example

The XML code for the example looks as follows:

<natpage xmlns:njx="http://www.softwareag.com/njx/njxMapConverter">
    <njx:xciwpinfo2>
    </njx:xciwpinfo2>
</natpage>

Adapter Interface

1 XCIWPINFO_CHANGEINDEX (I4)
1 XCIWPINFO_NODE (1:*)
2 ACTIVITYID (U) DYNAMIC
2 ACTIVITYURL (U) DYNAMIC
2 BUTTONSTYLE (U) DYNAMIC
2 DRAGINFO (U) DYNAMIC
2 FOLLOWPAGESWITCHES (L)
2 HEIGHT (I4)
2 ICONURL (U) DYNAMIC
2 LEFT (I4)
2 LEVEL (I4)
2 NAME (U) DYNAMIC
2 ONLYONEINSTANCE (L)
2 OPENED (I4)
2 TARGET (U) DYNAMIC
2 TEXTID (U) DYNAMIC
2 TOOLTIP (U) DYNAMIC
2 TOOLTIPID (U) DYNAMIC
2 TOP (I4)
2 TREECLASS (U) DYNAMIC
2 TREESTYLE (U) DYNAMIC
2 TYPE (U) DYNAMIC2 WIDTH (I4)

Each occurrence in the array XCIWPINFO_NODE describes a node in the function tree. The function tree consists of up to three levels: topics, folders and nodes.

Topic

The following structure elements are used to describe a topic:

Element Meaning

BUTTONSTYLE Style info that is passed to the button representing the topic.

ICONURL The button that represents this topic may have an additional icon in front of the text. Use this parameter to set the icon URL.

LEVEL
The following definition means "This is a topic":

LEVEL = 1

NAME Name of the topic.

TEXTID Multi language dependent text that is displayed inside the control. The TEXTID is translated into a corresponding string at runtime.

OPENED
The following definition means "The topic is closed":

OPENED = 0

The following definition means "The topic is opened":

OPENED = 1

TOOLTIP Text of the tooltip for the topic.

TOOLTIPID Multi language dependent text that is displayed inside the control. The TOOLTIPID is translated into a corresponding string at runtime.

TREECLASS Set the style class for rendering the tree area of the topic. There are ten standard style classes available in the default style sheet: PLACETOPIC1ClientTree to WORKPLACETOPIC10ClientTree. These style sheets can be maintained with the style sheet editor of the Application Designer.

TREESTYLE Background style for the tree. For example, you can define background colors and background pictures. Avoid the usage of single quote (') and double-quote (") characters.

Folder

The following structure elements are used to describe a folder:

Element Meaning

DRAGINFO Any information that is useful to react on a drop event. The single quote (') and backslash (\) characters are not allowed.

LEVEL
The following definitions mean "This is a folder":

LEVEL >= 2 and OPENED = 0

or

LEVEL >= 2 and OPENED = 1

NAME Name of the folder.

TEXTID Multi language dependent text that is displayed inside the control. The TEXTID is translated into a corresponding string at runtime.

OPENED
The following definition means "The folder is closed":

OPENED = 0

The following definition means "The folder is opened":

OPENED = 1

TOOLTIP Text of the tooltip for the folder.

TOOLTIPID Multi language dependent text that is displayed inside the control. The TOOLTIPID is translated into a corresponding string at runtime.

Node that opens a page in the "Content" frame

The following structure elements are used to describe a node that opens an Application Designer page or HTML page in the "Content" frame:

Element Meaning

ACTIVITYURL The URL to be loaded when the user clicks on a node. You can append parameters to the URL.

DRAGINFO Any information that is useful to react on a drop event. The single quote (') and backslash (\) characters are not allowed.

FOLLOWPAGESWITCHES If true, the workplace keeps the information when the user switches inside the content area from one page to the next. If the user reinvokes the page, the page to which the user switched last is shown, not the one from the ACTIVITYURL. The use of FOLLOWPAGESWITCHES only makes sense if ONLYONEINSTANCE is set to true.
The following applies for HTML pages: Registering of the navigation is only supported for HTML pages in the frame buffer. This means that you have to set the framebuffersize parameter in the cisconfig.xml file correspondingly.

ICONURL The URL for the icon which is shown in front of the name.

LEVEL
The following definition creates a node on level 2, that is, directly under a topic:

LEVEL = 2 and OPENED = 2

The following definition creates a node on level 3, that is, under a folder:

LEVEL = 3 and OPENED = 2

NAME Name of the node.

TEXTID Multi language dependent text that is displayed inside the control. The TEXTID is translated into a corresponding string at runtime.

ONLYONEINSTANCE A page with the corresponding name is only started once inside the workplace. If the page already exists, no new page is started but the existing one is used.

OPENED See the above description for LEVEL.

TOOLTIP Text of the tooltip for the tree node.

TOOLTIPID Multi language dependent text that is displayed inside the control. The TOOLTIPID is translated into a corresponding string at runtime.

TYPE "cis" to open an Application Designer page, or "html" to open an HTML page.

Node that opens a page in a pop-up window

The following structure elements are used to describe a node that opens an Application Designer page or HTML page in a pop-up window:

Element Meaning

ACTIVITYURL The URL to be loaded when the user clicks on a node. You can append parameters to the URL.

DRAGINFO Any information that is useful to react on a drop event. The single quote (') and backslash (\) characters are not allowed.

HEIGHT Set the dimension of the pop-up in pixels.

ICONURL The URL for the icon which is shown in front of the name.

LEFT Set the relative position of the pop-up in pixels.

LEVEL
The following definition creates a node on level 2, that is, directly under a topic:

LEVEL = 2 and OPENED = 2

The following definition creates a node on level 3, that is, under a folder:

LEVEL = 3 and OPENED = 2

NAME Name of the node.

TEXTID Multi language dependent text that is displayed inside the control. The TEXTID is translated into a corresponding string at runtime.

OPENED See the above description for LEVEL.

TOOLTIP Text of the tooltip for the tree node.

TOOLTIPID Multi language dependent text that is displayed inside the control. The TOOLTIPID is translated into a corresponding string at runtime.

TOP Set the relative position of the pop-up in pixels.

TYPE "cispopup" to open an Application Designer page, or "htmlpopup" to open an HTML page.

WIDTH Set the dimension of the pop-up in pixels.

Node that opens a page in a target frame

The following structure elements are used to describe a node that opens an Application Designer page or HTML page in a target frame other than the "Content" frame:

Element Meaning

ACTIVITYURL The URL to be loaded when the user clicks on a node. You can append parameters to the URL.

DRAGINFO Any information that is useful to react on a drop event. The single quote (') and backslash (\) characters are not allowed.

ICONURL The URL for the icon which is shown in front of the name.

LEVEL
The following definition creates a node on level 2, that is, directly under a topic:

LEVEL = 2 and OPENED = 2

The following definition creates a node on level 3, that is, under a folder:

LEVEL = 3 and OPENED = 2

NAME Name of the node.

TEXTID Multi language dependent text that is displayed inside the control. The TEXTID is translated into a corresponding string at runtime.

OPENED See the above description for LEVEL.

TARGET Name of the target frame in which the page is to be opened. During workplace definition, you assign a target ID to each frame you define.

TOOLTIP Text of the tooltip for the tree node.

TOOLTIPID Multi language dependent text that is displayed inside the control. The TOOLTIPID is translated into a corresponding string at runtime.

TYPE
"cistarget": Open an Application Designer page.

"htmltarget": Open an HTML page.

Element	Meaning
`BUTTONSTYLE`	Style info that is passed to the button representing the topic.
`ICONURL`	The button that represents this topic may have an additional icon in front of the text. Use this parameter to set the icon URL.
`LEVEL`	The following definition means "This is a topic": `LEVEL = 1`
`NAME`	Name of the topic.
`TEXTID`	Multi language dependent text that is displayed inside the control. The `TEXTID` is translated into a corresponding string at runtime.
`OPENED`	The following definition means "The topic is closed": `OPENED = 0` The following definition means "The topic is opened": `OPENED = 1`
`TOOLTIP`	Text of the tooltip for the topic.
`TOOLTIPID`	Multi language dependent text that is displayed inside the control. The `TOOLTIPID` is translated into a corresponding string at runtime.
`TREECLASS`	Set the style class for rendering the tree area of the topic. There are ten standard style classes available in the default style sheet: `PLACETOPIC1ClientTree` to `WORKPLACETOPIC10ClientTree`. These style sheets can be maintained with the style sheet editor of the Application Designer.
`TREESTYLE`	Background style for the tree. For example, you can define background colors and background pictures. Avoid the usage of single quote (') and double-quote (") characters.

Element	Meaning
`DRAGINFO`	Any information that is useful to react on a drop event. The single quote (') and backslash (\) characters are not allowed.
`LEVEL`	The following definitions mean "This is a folder": `LEVEL >= 2` and `OPENED = 0` or `LEVEL >= 2` and `OPENED = 1`
`NAME`	Name of the folder.
`TEXTID`	Multi language dependent text that is displayed inside the control. The `TEXTID` is translated into a corresponding string at runtime.
`OPENED`	The following definition means "The folder is closed": `OPENED = 0` The following definition means "The folder is opened": `OPENED = 1`
`TOOLTIP`	Text of the tooltip for the folder.
`TOOLTIPID`	Multi language dependent text that is displayed inside the control. The `TOOLTIPID` is translated into a corresponding string at runtime.

Element	Meaning
`ACTIVITYURL`	The URL to be loaded when the user clicks on a node. You can append parameters to the URL.
`DRAGINFO`	Any information that is useful to react on a drop event. The single quote (') and backslash (\) characters are not allowed.
`FOLLOWPAGESWITCHES`	If true, the workplace keeps the information when the user switches inside the content area from one page to the next. If the user reinvokes the page, the page to which the user switched last is shown, not the one from the `ACTIVITYURL`. The use of `FOLLOWPAGESWITCHES` only makes sense if `ONLYONEINSTANCE` is set to true. The following applies for HTML pages: Registering of the navigation is only supported for HTML pages in the frame buffer. This means that you have to set the `framebuffersize` parameter in the cisconfig.xml file correspondingly.
`ICONURL`	The URL for the icon which is shown in front of the name.
`LEVEL`	The following definition creates a node on level 2, that is, directly under a topic: `LEVEL = 2` and `OPENED = 2` The following definition creates a node on level 3, that is, under a folder: `LEVEL = 3` and `OPENED = 2`
`NAME`	Name of the node.
`TEXTID`	Multi language dependent text that is displayed inside the control. The `TEXTID` is translated into a corresponding string at runtime.
`ONLYONEINSTANCE`	A page with the corresponding name is only started once inside the workplace. If the page already exists, no new page is started but the existing one is used.
`OPENED`	See the above description for `LEVEL`.
`TOOLTIP`	Text of the tooltip for the tree node.
`TOOLTIPID`	Multi language dependent text that is displayed inside the control. The `TOOLTIPID` is translated into a corresponding string at runtime.
`TYPE`	"cis" to open an Application Designer page, or "html" to open an HTML page.

Element	Meaning
`ACTIVITYURL`	The URL to be loaded when the user clicks on a node. You can append parameters to the URL.
`DRAGINFO`	Any information that is useful to react on a drop event. The single quote (') and backslash (\) characters are not allowed.
`HEIGHT`	Set the dimension of the pop-up in pixels.
`ICONURL`	The URL for the icon which is shown in front of the name.
`LEFT`	Set the relative position of the pop-up in pixels.
`LEVEL`	The following definition creates a node on level 2, that is, directly under a topic: `LEVEL = 2` and `OPENED = 2` The following definition creates a node on level 3, that is, under a folder: `LEVEL = 3` and `OPENED = 2`
`NAME`	Name of the node.
`TEXTID`	Multi language dependent text that is displayed inside the control. The `TEXTID` is translated into a corresponding string at runtime.
`OPENED`	See the above description for `LEVEL`.
`TOOLTIP`	Text of the tooltip for the tree node.
`TOOLTIPID`	Multi language dependent text that is displayed inside the control. The `TOOLTIPID` is translated into a corresponding string at runtime.
`TOP`	Set the relative position of the pop-up in pixels.
`TYPE`	"cispopup" to open an Application Designer page, or "htmlpopup" to open an HTML page.
`WIDTH`	Set the dimension of the pop-up in pixels.

Element	Meaning
`ACTIVITYURL`	The URL to be loaded when the user clicks on a node. You can append parameters to the URL.
`DRAGINFO`	Any information that is useful to react on a drop event. The single quote (') and backslash (\) characters are not allowed.
`ICONURL`	The URL for the icon which is shown in front of the name.
`LEVEL`	The following definition creates a node on level 2, that is, directly under a topic: `LEVEL = 2` and `OPENED = 2` The following definition creates a node on level 3, that is, under a folder: `LEVEL = 3` and `OPENED = 2`
`NAME`	Name of the node.
`TEXTID`	Multi language dependent text that is displayed inside the control. The `TEXTID` is translated into a corresponding string at runtime.
`OPENED`	See the above description for `LEVEL`.
`TARGET`	Name of the target frame in which the page is to be opened. During workplace definition, you assign a target ID to each frame you define.
`TOOLTIP`	Text of the tooltip for the tree node.
`TOOLTIPID`	Multi language dependent text that is displayed inside the control. The `TOOLTIPID` is translated into a corresponding string at runtime.
`TYPE`	"cistarget": Open an Application Designer page. "htmltarget": Open an HTML page.

When the structure is passed to the application, it contains the information about the current function tree. The application may change this information and return it. In order to indicate that the function tree shall be updated in the user interface, the application must modify the value of XCIWPINFO_CHANGEINDEX on return. This is achieved, for instance, by the following statement:

ADD 1 TO XCIWPINFO_CHANGEINDEX