Version 4.2.6 for Mainframes
 —  Natural for Ajax  —

NJX:XCIWPFUNCTIONS

The NJX:XCIWPFUNCTIONS control is used to modify the function tree that is shown in the "Functions" frame (MFWPFUNCTIONS) incrementally. In order to access the content of the function tree or to exchange it as a whole, you have to use the NJX:XCIWPINFO2 control.

The NJX:XCIWPFUNCTIONS 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

The XML code for the example looks as follows:

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

Top of page

Adapter Interface

1 XCIWPFUNCTIONS (1:*)
2 CMDADDFOLDER
3 ADDFOLDER_ASFIRST (L)
3 ADDFOLDER_FOLDERNAME (A) DYNAMIC
3 ADDFOLDER_OPENED (I4)
3 ADDFOLDER_TOPICNAME (A) DYNAMIC
2 CMDADDNODE
3 ADDNODE_ACTIVITYURL (A) DYNAMIC
3 ADDNODE_ASFIRST (L)
3 ADDNODE_FOLDERNAME (A) DYNAMIC
3 ADDNODE_HEIGHT (I4)
3 ADDNODE_LEFT (I4)
3 ADDNODE_NAME (A) DYNAMIC
3 ADDNODE_TARGET (A) DYNAMIC
3 ADDNODE_TOP (I4)
3 ADDNODE_TOPICNAME (A) DYNAMIC
3 ADDNODE_TYPE (A) DYNAMIC
3 ADDNODE_WIDTH (I4)
2 CMDADDTOPIC
3 ADDTOPIC_SWITCHTOTOPIC (L)
3 ADDTOPIC_TOPICNAME (A) DYNAMIC
3 ADDTOPIC_TREECLASS (A) DYNAMIC
2 CMDREMFOLDER
3 REMFOLDER_FOLDERNAME (A) DYNAMIC
3 REMFOLDER_TOPICNAME (A) DYNAMIC
2 CMDREMNODE
3 REMNODE_FOLDERNAME (A) DYNAMIC
3 REMNODE_NAME (A) DYNAMIC
3 REMNODE_TOPICNAME (A) DYNAMIC
2 CMDREMTOPIC
3 REMTOPIC_TOPICNAME (A) DYNAMIC

Each occurrence in the array XCIWPFUNCTIONS describes a command that is to be sent to the workplace API. Several commands can be sent in a sequence. For each command, a corresponding substructure must be filled.

Add a topic

The following structure elements belong to CMDADDTOPIC:

Element Meaning
ADDTOPIC_SWITCHTOTOPIC "true": Open the new topic.
ADDTOPIC_TOPICNAME Name of the topic.
ADDTOPIC_TREECLASS Sets 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.
Add a folder

The following structure elements belong to CMDADDFOLDER:

Element Meaning
ADDFOLDER_ASFIRST

"true": Add this folder as the first folder under the given topic.

"false": Add this folder as the last folder under the given topic.

ADDFOLDER_FOLDERNAME Name of the folder.
ADDFOLDER_OPENED

0: Add the folder as a closed folder with potential subnodes.

1: Add the folder as an opened folder.

2: Add the folder as a closed folder without subnodes.

ADDFOLDER_TOPICNAME Name of the topic to which the folder is to be added.
Add a node

The following structure elements belong to CMDADDNODE:

Element Meaning
ADDNODE_NAME Name of the node to be added.
ADDNODE_FOLDERNAME Name of the folder to which the node is to be added.
ADDNODE_TOPICNAME Name of the topic that contains this folder.
ADDNODE_ASFIRST

"true": Add this node as the first node under the given folder.

"false": Add this node as the last node under the given folder.

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

"cis": A node that opens an Application Designer page in the "Content" frame.

"html": A node that opens an HTML page in the "Content" frame.

"cispopup": A node that opens an Application Designer page in a pop-up window.

"htmlpopup": A node that opens an HTML page in a pop-up window.

"cistarget": A node that opens an Application Designer page in a target frame other than the "Content" frame.

"htmlpopup": A node that opens an HTML page in a target frame other than the "Content" frame.

ADDNODE_LEFT Only with type "cispopup" and "htmlpopup". Set the relative position of the pop-up in pixels.
ADDNODE_TOP Only with type "cispopup" and "htmlpopup". Set the relative position of the pop-up in pixels.
ADDNODE_HEIGHT Only with type "cispopup" and "htmlpopup". Set the dimension of the pop-up in pixels.
ADDNODE_WIDTH Only with type "cispopup" and "htmlpopup". Set the dimension of the pop-up in pixels.
ADDNODE_TARGET Only with type "cistarget" and "htmltarget". 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.
Remove a topic

The following structure element belongs to CMDREMTOPIC:

Element Meaning
REMTOPIC_TOPICNAME Name of the topic to be removed.
Remove a folder

The following structure elements belong to CMDREMFOLDER:

Element Meaning
REMFOLDER_FOLDERNAME Name of the folder to be removed.
REMFOLDER_TOPICNAME Name of the topic that contains the folder.
Remove a node

The following structure elements belong to CMDREMNODE:

Element Meaning
REMNODE_FOLDERNAME Name of the folder that contains the node to be removed.
REMNODE_NAME Name of the node to be removed.
REMNODE_TOPICNAME Name of the topic that contains the folder with the node to be removed.

Top of page