Client Methods

This document lists the most common methods that are used in Client Tasks in the Jargon Writer Task Editor. There are many methods that can be applied to individual containers and components, including:

getting the current value of a component such as a textfield, textarea, combo box, listbox or table cell
assigning the displayed value in a component such as a textfield, textarea or table cell
selecting ("checking") or unselecting a radio button or checkbox
making a container or component visible or hidden
making a component enabled or disabled for receiving user input and focus
assigning or changing an object's title, caption or image
adding or selecting a specific value in a combobox or listbox
inserting, appending or removing rows in a table
adding or changing the value of a table row or individual cell
bringing a specific panel to the "top" in a cardpanel or tabpanel

In addition, several powerful utility methods can be applied to the client app "root" object:

invoke a browser to display a specified URL (local or remote web page or image)
invoke any existing tasklist in any client app
dispose of an app (memory management)
obtain the name of the object whose event caused the current tasklist to be executed.

Selecting a Method
Methods can be selected from a target object's specific class or from any of its parent classes (superclasses). When a target object is selected in a Client Task, the middle panel of the Task Editor will show the class hierarchy of that target object, in the "Declaring Objects" listbox. The most general parent class ("java.lang.Object") is at the top, followed by more specific subclasses, ending with the object's specific class at the bottom. Click on a class to see an alphabetical list of its available methods in the "Target method" listbox. For each method, its name, parameters and return value are listed.

User Tip: A new MethodList feature introduced in Version 2.1 allows you to choose an alternative way to list the available methods for each type of target object. With this feature, the middle panel of the Task Editor will show one combined list of methods from an object's class and all its parent classes. This new list will be sorted alphabetically and filtered to show only those methods supported in all deployment engines (Jargon Reader, Jargon ReaderX, and any others that may be added in future versions).
This feature is enabled by the presence of a "MethodList" value in the system\preferences.ini file. To shut off the feature, comment out this entry by placing a "#" character at the start of the line containing "MethodList=". The default entry is:

MethodList=./system/jsimethods.xml

Method Return Values
If the method returns a value, the object type will be listed in the "Return type" column. An entry of "void" means that no value is returned. Common return types are "string" (also called "java.lang.String"), "int" and "boolean". Methods with return values are used in host tasks to populate host parameters with the current contents of objects such as textfields, and may also be used as subtasks to populate the parameters of a task in a client method (these can be nested multiple levels if needed).

Method Parameters
Many methods have one or more parameters that are one of the basic object types: "string" ("java.lang.String"), "int" or "boolean". In general, methods which require parameters that are more complex objects cannot be used for Client Tasks unless there is another method which can be specified as a subtask to populate the parameter with that kind of object value.

An "int" parameter can only contain positive or negative integers, such as -2, -1, 0, 1, 2, ... 9999 ... etc. (do not enter commas within the integer). Note: negative values are not meaningful in most integer parameters.
A "boolean" parameter can only have the lowercase value "true" or "false" (do not enter the quotation marks).
A "string" parameter can have any zero or more characters.

User Tip: Note that some string parameters specify an "object name" that names a container or component object to which the method will be applied, such as the name of a tab within a tab panel. These names are case-sensitive, meaning that upper and lower case must exactly match the name used in Jargon Writer for this object. This means that 'tabone' and 'TabOne' cannot be used interchangeably to reference the same client object. This rule is different than the syntax used in many other languages, and can be the cause of numerous errors if not carefully followed.

Documentation Format
The following format is used for the methods described in this document:

Method: a method name within that class, followed by an ordered list of any required parameters (in parentheses)

Object: the class name in the Declaring Objects listbox (note that this is NOT USED with the MethodList option)

Return: type of value returned by the method ("void" means none)

Param0: description of the first parameter (if any)

Param1: description of the second parameter (etc.)

Utility Methods

Dispose of an App (remove from memory)
This method is used to remove an app from memory. If a disposed app is referenced again later, it will be reopened and reinitialized as if it had never been opened during the session. When closing or exiting an app which uses an "internal frame", this method should be used in the "exit" tasklist, as opposed to hiding the internal frame.

Method: dispose()

Object: com.jargonsoft.app.App

Return: void

Params: none

Get Current App Name
This method returns the name of the app that contains the tasklist that is currently being executed. One use for this method is to provide a generic way to get an app name that will be later used in an "invokeTasklist" method. An example is the way the "callback app" name is obtained in the reusable browse tasklists generated by Jargon Replicator.

Method: getCurrentAppName()

Object: com.jargonsoft.app.App

Return: string

Params: none

Get Event Source Name
This method returns the name of the object (like a button name) that was the source of the latest event. This name could be used as a host parameter to tell the host program which button was clicked. For an example, see how host tasks for the First/Prev/Next/Last buttons are handled in apps created by Jargon Replicator.

Method: getEventSourceName()

Object: com.jargonsoft.app.App

Return: string

Params: none

Get Preference Value
Get Preference Value No Error
These methods both return a string that is the value of the specified preference item in the currently executing session. Preferences are name/value pairs that are used by Jargon Software programs to specify directories, URLs, script names and other options which control the operation of these programs. Application-specific preferences can also be added as desired by developers, so long as the assigned preference names do not conflict with any predefined names. Such application preferences provide a convenient way to easily configure or "tune" options and default values in client apps, without having to modify the apps as would be necessary if the values were "hard-coded" within the app itself.
The only difference between the two methods is that if the specified preference name is not found, "Get Preference Value" will display a runtime error to the user, whereas "Get Preference Value No Error" will simply return a blank (empty) preference value. The first method is typically used with required preferences, and the "no error" method is useful for optional preferences that may or may not exist in the startup file that contains the preference entries.
Jargon Writer and Jargon Reader load preference values from the "system/preferences.ini" file (by default) or from a similarly structured "ini" file of another name as specified in their startup command. Jargon ReaderX loads its preference values from the startup HTML page (in PARAM entries within the "Object" section for Internet Explorer and in name/value parameters within the "EMBED" section for Netscape Navigator).

Method: getPreferenceValue(string preferenceName)

--OR--: getPreferenceValueNoError(string preferenceName)

Object: com.jargonsoft.app.App

Return: string

Param0: (preferenceName) A case-sensitive string value that is the name of the preference item whose value is to be returned. Example: "HostURL".

Get Product ID
This method returns the name of the deployment product in which the current app is being executed. As of Version 2.1, this will return either "ReaderX" for Jargon ReaderX, or "Reader" for Jargon Writer and Jargon Reader (note that executing an app within Jargon Writer really executes it with an embedded copy of Jargon Reader).

Method: getProductID()

Object: com.jargonsoft.app.App

Return: string

Params: none

Open an App
This method is used to execute a specified app. The app's initial tasklist will be run if this is the first time the app is run.

Method: openApp(string appName)

Object: com.jargonsoft.app.App

Return: void

Param0: (appName) The name of the client app (without the ".xml" suffix) to be run. If the app is not currently open, it will be loaded and its initial tasklist will be executed.

Invoke a Tasklist (in another app)
This method is used to execute an existing tasklist in a specified app. The tasklist can contain any valid list of tasks, and is executed just as if it were linked to a client event which had just taken place.

Method: invokeTasklist(string appName, string tasklistName)

Object: com.jargonsoft.app.App

Return: void

Param0: (appName) The name of the client app (without the ".xml" suffix) in which a tasklist is to be invoked. If the app is not currently open, it will be loaded and its initial tasklist will be executed.

Param1: (tasklistName) The case-sensitive internal name of the tasklist to be invoked in the specified app.

Invoke a Tasklist (in the same app)
This method is used to execute an existing tasklist in the currently executing app (the one which contains the client task that uses this method). The tasklist can contain any valid list of tasks, and is executed just as if it were linked to a client event which had just taken place. NOTE: this method is distinguished from the previous "invokeTasklist" method by the number of parameters that it uses.

Method: invokeTasklist(string tasklistName)

Object: com.jargonsoft.app.App

Return: void

Param0: (tasklistName) The case-sensitive internal name of the tasklist to be invoked in the current app.

Display a URL in a New Browser Window
This method is used to display an HTML web page, an image file or any other valid browser object with a specified URL. The browser is invoked on the client system using the command specified in the preferences.ini value for the BrowserCommand parameter. A new browser window will be opened each time this method is executed.

Method: showDocument(string docURL)

Object: com.jargonsoft.app.App

Return: void

Param0: (docURL) The remote or local URL to be displayed in the browser, such as "http://www.jargonsoft.com/index.html" or "C:\jargonsoft\doc\index.html".

Display a URL in a Specified Browser Window
This method is used to display an HTML web page, an image file or any other valid browser object with a specified URL. The browser is invoked on the client system using the command specified in the preferences.ini value for the BrowserCommand parameter. The same "named" browser window will be used each time this method is executed. A new window will be opened if no window with the specified name is currently open.

Method: showDocumentInTarget(string docURL, string targetWindowName)

Object: com.jargonsoft.app.App

Return: void

Param0: (docURL) The remote or local URL to be displayed in the browser, such as "http://www.jargonsoft.com/index.html" or "C:\jargonsoft\doc\index.html".

Param1: (targetWindowName) A string value that assigns a unique name to a browser window so that multiple documents can be displayed within the same window. For example, an application might use this method to display all online help documents in a browser window with a targetWindowName of "Help".

Math and Data Type Conversion Methods
These methods in the "MathUtility" class can be used to convert data types (string to boolean, date, decimal or integer, or vice versa, and integer/decimal conversions), and to do simple integer and decimal arithmetic (add, subtract, multiply, divide).

To use these methods, select the "Misc" component toolbar and add a "MathUtility" object under the MiscContainer in the component tree (where the MsgHandler also resides). Then use this MathUtility object as the target object of a middle subtask to supply a parent task with a result that becomes a parameter of the correct type for the parent task.

Here is an example that multiplies two integer values from textfields "tf1" and "tf2", converts the integer result to a string, and displays the string result in textfield "tf3". Note that there are three levels of subtasks involved. The notation used is: targetObject.targetMethod(params).

tf3.displayText(
      MathUtility.intToString(
                  MathUtility.intMultiply(
                              tf1.getIntegerValue, tf2.getIntegerValue) ) )

All of these methods are in the object: com.jargonsoft.jfccomponents.utility.MathUtility

Integer Arithmetic Methods
These methods all take two integer parameters and return an integer value that is the result of the calculation. Note: The previously used integer math methods "add", "subtract", "multiply" and "divide" are still supported but are deprecated and should be replaced by the "intXXX" methods.

intAdd (int,int) Adds the first integer and the second integer.
intSubtract(int,int) Subtracts the second integer from the first integer.
intMultiply(int,int) Multiplies the first integer by the second integer.
intDivide (int,int) Divides the first integer by the second integer.

Decimal Arithmetic Methods
These methods all take two decimal parameters and return an decimal value that is the result of the calculation.

decAdd (int,int) Adds the first decimal and the second decimal.
decSubtract(int,int) Subtracts the second decimal from the first decimal.
decMultiply(int,int) Multiplies the first decimal by the second decimal.
decDivide (int,int) Divides the first decimal by the second decimal.

Data Type Conversion Methods
These methods all convert a string to another data type, or vice versa.

stringToBoolean(string) Returns a boolean value from string 'true' or 'false'.
stringToDate (string) Returns a date object from a date in a string.
stringToDecimal(string) Returns a decimal object from a decimal value in a string.
stringToInteger(string) Returns an int value from an integer value in a string.

booleanToString(boolean) Returns string 'true' or 'false' from a boolean value.
decimalToString(decimal) Returns a string value of a decimal object.
intToString (int) Returns a string value from an int value.

These method convert an integer to a decimal or vice versa.

intToDecimal(int) Returns a decimal value from an integer value.
decimalToInt(decimal) Returns an integer value from a decimal value by truncating any decimal places. For example, decimalToInt(3.6) will return the value "3". To round, add the decimal value "0.5" to the decimal value before using this method.

Container Methods
These methods are used with various container objects (frames, panels, cardpanels, tabpanels). There are both generic container methods which can be used with any container type, and other methods that are specific to a particular container type.

Generic Container
These methods can be used on any container object (frame, panel, cardpanel, tabpanel).

View or Hide a Container and its Contents
This method is used to make a container visible or invisible (hidden).

Method: setVisible(boolean b)

Object: (various)

Return: void

Param0: (b) "true" to make visible, "false" to hide

Repaint
This method is used to force a repaint of the screen so that a container whose contents have been changed in some way (such as changing a component's font, color or image) will be made visible immediately. Usually used on frame objects.

Method: repaint()

Object: java.awt.Component

Return: void

Params: none

Frame

Center a Frame
This method is used to center a frame within the display area of the user's monitor.

Method: center()

Object: com.jargonsoft.jfccomponents.JSIFrame

Return: void

Params: none

Pack a Frame
This method is used to make the layout manager routine recalculate the size and location of all graphical components and containers. It is often used after changing component font sizes, for example, to resize the components so they are large enough to hold the same number of "average" characters as before.

Method: pack()

Object: com.jargonsoft.jfccomponents.JSIFrame

Return: void

Params: none

Put Focus on a Frame
This method is used to request that focus be put on a frame.

Method: requestFocus()

Object: java.awt.Component

Return: void

Params: none

Position a Frame at Absolute X/Y Coordinates
This method is used to position a frame with its upper lefthand corner at a specific location. Be sure to allow enough room to the right and below for the frame to fit within the screen display, and allow for users who may run at lower resolutions.

Method: setLocation(int nXPos, int nYPos)

Object: com.jargonsoft.jfccomponents.JSIFrame

Return: void

Param0: (nXPos) The "X" (horizontal) pixel position of the upper lefthand corner of the frame. On an 800x600 resolution display, this value can be 0-799.

Param1: (nYPos) The "Y" (vertical) pixel position of the upper lefthand corner of the frame. On an 800x600 resolution display, this value can be 0-599.

Display a Status Message
This method is used to display a one-line message in a frame's status panel (at the bottom of the frame).

Method: setMessage(string message)

Object: java.awt.Frame

Return: void

Param0: (message) A one-line message string to be displayed.

Resize a Frame in Absolute Pixel Values
This method is used to resize a frame to a specific width and height, measured in pixels.

Method: setSize(int nWidth, int nHeight)

Object: com.jargonsoft.jfccomponents.JSIFrame

Return: void

Param0: (nWidth) The "X" (horizontal) pixel width of the frame. On an 800x600 resolution display, this value can be 0-799.

Param1: (nHeight) The "Y" (vertical) pixel height of the frame. On an 800x600 resolution display, this value can be 0-599.

Change a Frame Title
This method is used to dynamically change the title displayed iin a frame's title bar.

Method: setTitle(string title)

Object: java.awt.Frame

Return: void

Param0: (title) The character string to display (left-justified) in the frame's title bar (at the top).

System Exit (end session)
This method is used to do a "system exit" which ends the current session (including Jargon Reader/ReaderX and all application programs) and returns all memory to the client operating system. It can be the last task in a tasklist that is associated with a "Logout" or "Exit" button, for example.

Method: systemExit()

Object: com.jargonsoft.jfccomponents.JSIFrame

Return: void

Params: none

Panel, Tab in a TabPanel, Card in a CardPanel

Note that cards and tabs are just specialized versions of regular panels. Cards are panels stacked on top of each other; only a program method can change which card is on top. Tabs are like cards with a titled "tab" attached, so either a program method or a user mouse click or keyboard action can change which tab is on top.
Display Default Values of all Panel Components
This method is used to display the default value of each component of a panel (usually used to reset to original values as instantiated).

Method: setComponentDefaultValues()

Object: com.jargonsoft.jfccomponents.JSIPanel

Return: void

Params: none

Enable or Disable all Panel Components
This method is used to enable or disable all components of a panel.

Method: setComponentEnabledStates(boolean b)

Object: com.jargonsoft.jfccomponents.JSIPanel

Return: void

Param0: (b) "true" to enable, "false" to disable

Get Tab Title (Tab of Tabpanel only)
This method is used to get the title which is displayed on a tab of a tabpanel.

Method: getTitle()

Object: com.jargonsoft.jfccomponents.JSITab

Return: string

Params: none

Card Panel

Display a Card in a Card Panel
This method is used to change the panel within the card panel that is currently displayed.

Method: setPanelVisible(string panelName)

Object: com.jargonsoft.jfccomponents.JSICardPanel

Return: void

Param0: (panelName) The internal name of the card (overlaid panel) within this cardpanel that should be brought to the top so that its contents are displayed.

Tab Panel

Display a Tab in a Tab Panel by Name
This method is used to change the tab that is currently displayed within the tab panel by specifying a tab name.

Method: setTab(string tabName)

Object: com.jargonsoft.jfccomponents.JSITabPanel

Return: void

Param0: (tabName) The internal name of the tab within this tabpanel that should be brought to the top so that its contents are displayed.

Display a Tab in a Tab Panel by Number
This method is used to change the tab that is currently displayed within the tab panel by specifying a tab number (starting from zero).

Method: setTabIndex(int tabNumber)

Object: com.jargonsoft.jfccomponents.JSITabPanel

Return: void

Param0: (tabNumber) The number (leftmost tab is zero) of the tab within this tabpanel that should be brought to the top so that its contents are displayed.

Get Name of Selected Tab in a Tab Panel
This method is used to get the Object Name of the tab that is currently displayed within the tab panel. Since users can bring up different tabs by clicking on them, this provides a way to see which tab is currently visible ("on top").

Method: getSelectedPanelName()

Object: com.jargonsoft.jfccomponents.JSITabPanel

Return: string

Params: none

Internal Frame Container

This component has no associated client methods.

Misc. Container

This component has no associated client methods.

Component Methods
These methods are used with various component objects (objects which are not containers). There are both generic component methods which can be used with any component type, and other methods that are specific to a particular component type.

Generic Component
These methods can be used on any component object.

Enable or Disable a Component
This method is used to enable or disable any component which can be affected by a user action such as entering data, selecting a value, or clicking. This method is not available for "display-only" components such as labels and textpanes.

Method: setEnabled(boolean b)

Object: (various)

Return: void

Param0: (b) "true" to enable, "false" to disable

Put Focus on a Component
This method is used to request that focus be put on a component.

Method: requestFocus()

Object: javax.swing.JComponent

Return: void

Params: none

View or Hide a Component
This method is used to make a component visible or invisible (hidden).

Method: setVisible(boolean b)

Object: javax.swing.JComponent

Return: void

Param0: (b) "true" to make visible, "false" to hide

Button

Change a Button Caption
This method is used to change the caption on a button.

Method: setLabel(string label)

Object: javax.swing.AbstractButton

Return: void

Param0: (label) A character string to be displayed as the caption (label) of this button

Checkbox

Select or Unselect a Checkbox
These methods are used to select (check) or unselect (clear) a checkbox.

Method: setState(boolean b)

--OR--: setSelected(boolean b)

Object: com.jargonsoft.jfccomponents.JSICheckBox

Return: void

Param0: (b) "true" to select, "false" to unselect

Assign Default Value of a Checkbox
This method is used to assign the default state of a checkbox (selected or unselected).

Method: setDefaultValue(boolean b)

Object: com.jargonsoft.jfccomponents.JSICheckBox

Return: void

Param0: (b) "true" for selected default, "false" for unselected

Display Default Value of a Checkbox
This method is used to redisplay a checkbox in its default state (selected or unselected).

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.JSICheckBox

Return: void

Params: none

Get String Value of Current Checkbox State
This method is used to get the string value ('true' or 'false') of the current selection state of a checkbox.

Method: getCurrentValue()

Object: com.jargonsoft.jfccomponents.JSICheckBox

Return: string

Params: none

Get Boolean Value of Current Checkbox State
These methods are used to get the boolean value (true or false) of the current selection state of a checkbox. This could be used as a subtask to populate a boolean parameter of another method, for example.

Method: getLogicalValue()

--OR--: getDefaultValue()

Object: com.jargonsoft.jfccomponents.JSICheckBox

Return: string

Params: none

Change a Checkbox Label
This method is used to change the label on a checkbox.

Method: setLabel(string label)

Object: javax.swing.AbstractButton

Return: void

Param0: (label) A character string to be displayed as the caption (label) of this checkbox

Combobox

Get Current Value
This method is used to get the string value of the currently selected (or entered) item in a combo box.

Method: getCurrentValue()

--OR--: getSelectedString()

Object: com.jargonsoft.jfccomponents.JSIComboBox

Return: string

Params: none

Insert or Append List Item(s)
This method is used to add one or more choices to the selection list. New list items can be appended to the end (bottom) of the list of choices or inserted at a specified location in the list.

Method: addObject(boolean bInsert, int nIndex, string data)

Object: com.jargonsoft.jfccomponents.JSIComboBox

Return: void

Param0: (bInsert) Insert if 'true', append to end of list if 'false'

Param1: (nIndex) Insertion position in list, from 0 to (n-1) for a list of 'n' choices. Ignored if Param0 is 'false'.

Param2: (data) A character string to be added as a selection choice. A choice cannot contain a comma. To add multiple choices, separate the string values with commas (ex: "First Choice,Second Choice").

Append List Item(s)
This method is used to add one or more choices to the end (bottom) of the selection list.

Method: addObject(string data)

Object: com.jargonsoft.jfccomponents.JSIComboBox

Return: void

Param0: (data) A character string to be added as a selection choice. A choice cannot contain a comma. To add multiple choices, separate the string values with commas (ex: "First Choice,Second Choice").

Assign Default Selection
This method is used to assign the default selection (must be a choice in the selection list).

Method: setDefaultValue(string text)

Object: com.jargonsoft.jfccomponents.JSIComboBox

Return: void

Param0: (text) A case-sensitive character string that must exactly match one of the current choices in the selection list.

Display Default Selection
This method is used to set the currently selected item to the default selection.

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.JSIComboBox

Return: void

Params: none

Select List Item by Number
This method is used to set the currently selected item to the n'th choice in the selection list. The selections are numbered starting with zero, so valid parameter values are 0,1,2,3 ... (n-1) for a list with n selections.

Method: setSelectedIndex(int nIndex)

Object: com.jargonsoft.jfccomponents.JSIComboBox

Return: void

Param0: (nIndex) An integer value from 0 to (n - 1), where n is the number of current choices in the combobox.

Select List Item by Value
This method is used to set the currently selected item by specifying the value of one of the choices.

Method: setSelectedItem(string text)

Object: com.jargonsoft.jfccomponents.JSIComboBox

Return: void

Param0: (text) A case-sensitive character string that must exactly match one of the current choices in the selection list.

Set Font
This method assigns the font used to display text values in this component. A font has three parameters (font face, style and point size). These parameters can only be specified directly for textareas and textpanes. All other components, including this one, must copy a font from another component that already has the desired font.

Method: setFont(java.awt.Font fontObject)

Object: javax.swing.JComponent

Return: void

Param0: (fontObject) This is a complex object that cannot be entered directly. Instead, use a subtask to apply the method getFont to a textarea or textpane that already has the desired font. The subtask will return the correct "java.awt.Font" object to supply a value for this parameter.

Remove All List Items
This method is used to remove all choices from the selection list (clear the combobox).

Method: removeAllItems()

Object: javax.swing.JComboBox

Return: void

Params: none

Label

Get Label Text
This method is used to get the character string that is the text of a label.

Method: getText()

Object: com.jargonsoft.jfccomponents.JSILabel

Return: string

Params: none

Assign Label Text
This method is used to change the displayed text of a label.

Method: setText(string label)

Object: javax.swing.JLabel

Return: void

Param0: (label) A character string that is the label text to be displayed.

Set Font
This method assigns the font used to display text values in this component. A font has three parameters (font face, style and point size). These parameters can only be specified directly for textareas and textpanes. All other components, including this one, must copy a font from another component that already has the desired font.

Method: setFont(java.awt.Font fontObject)

Object: javax.swing.JComponent

Return: void

Param0: (fontObject) This is a complex object that cannot be entered directly. Instead, use a subtask to apply the method getFont to a textarea or textpane that already has the desired font. The subtask will return the correct "java.awt.Font" object to supply a value for this parameter.

Listbox

Get Current Value
This method is used to get the string value of the currently selected item in a listbox.

Method: getCurrentValue()

--OR--: getSelectedString()

Object: com.jargonsoft.jfccomponents.JSIListBox

Return: string

Params: none

Add List Item(s)
This method is used to add one or more choices to the selection list. New list items can be appended to the end (bottom) of the list of choices or inserted at a specified location in the list. Choices are separated by commas.

Method: addObject(boolean bInsert, int nIndex, string data)

Object: com.jargonsoft.jfccomponents.JSIListBox

Return: void

Param0: (bInsert) Insert if 'true', append to end of list if 'false'

Param1: (nIndex) Insertion position in list, from 0 to (n-1) for a list of 'n' choices. Ignored if Param0 is 'false'.

Param2: (data) A character string to be added as a selection choice. A choice cannot contain a comma. To add multiple choices, separate the string values with commas (ex: "First Choice,Second Choice").

Add List Items With Specified Delimiter
This method is used to append one or more choices to the end (bottom) of the list of choices, using a specified delimiter to separate list choices.

Method: addList(string data, string delimiter)

Object: com.jargonsoft.jfccomponents.JSIListBox

Return: void

Param0: (data) A character string to be added as a selection choice. A choice cannot contain the delimiter character. To add multiple choices, separate the string values with the specified delimiter character (such as "^"). Ex: "Hello, World^Hello, Universe").

Param1: (delimiter) A single character to be used as the delimiter that separates choices. If choices might contain commas, a recommended delimiter is the caret symbol ("^").

Assign Default Selection
This method is used to assign the default selection (must be a choice in the selection list).

Method: setDefaultValue(string text)

Object: com.jargonsoft.jfccomponents.JSIListBox

Return: void

Param0: (text) A case-sensitive character string that must exactly match one of the current choices in the selection list.

Select the Default Selection
This method is used to set the currently selected item to the default selection.

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.JSIListBox

Return: void

Params: none

Select List Item by Number
This method is used to set the currently selected item to the n'th choice in the selection list. The selections are numbered starting with zero, so valid parameter values are 0,1,2,3 ... (n-1) for a list with n selections.

Method: setSelectedIndex(int nIndex)

Object: com.jargonsoft.jfccomponents.JSIListBox

Return: void

Param0: (nIndex) An integer value from 0 to (n - 1), where n is the number of current choices in the combobox.

Select List Item by Value
This method is used to set the currently selected item by specifying the value of one of the choices.

Method: setSelectedItem(string text)

Object: com.jargonsoft.jfccomponents.JSIListBox

Return: void

Param0: (text) A case-sensitive character string that must exactly match one of the current choices in the selection list.

Set Font
This method assigns the font used to display text values in this component. A font has three parameters (font face, style and point size). These parameters can only be specified directly for textareas and textpanes. All other components, including this one, must copy a font from another component that already has the desired font.

Method: setFont(java.awt.Font fontObject)

Object: javax.swing.JComponent

Return: void

Param0: (fontObject) This is a complex object that cannot be entered directly. Instead, use a subtask to apply the method getFont to a textarea or textpane that already has the desired font. The subtask will return the correct "java.awt.Font" object to supply a value for this parameter.

Remove All List Items
This method is used to remove all choices from the selection list (clear the combobox).

Method: removeAllItems()

Object: com.jargonsoft.jfccomponents.JSIListBox

Return: void

Params: none

Menubar, Menu, and Menu Item

These components have no associated client methods.

Message Box (msgHandler object in a miscContainer)

Message Box
This method is used to display an informational message to the user, in a modal dialog box with an OK button.

Method: messageBox(string msg)

Object: com.jargonsoft.jfccomponents.utility.JFCUtility

Return: void

Param0: (msg) A character string for a one-line message to be displayed in the message box. Cannot contain the comma (",") character.

Message Box and Place Focus
This method is used to display an informational message to the user, in a modal dialog box with an OK button. After the message box is dismissed by the user clicking OK, focus is placed on the specified component.

Method: messageBox(string compName, string msg)

Object: com.jargonsoft.jfccomponents.utility.JFCUtility

Return: void

Param0: (compName) The internal name of the frame or other component that should get focus after the user clicks the OK button.

Param1: (msg) A character string for a one-line message to be displayed in the message box. Cannot contain the comma (",") character.

Warning Box
This method is used to display an error or warning message to the user, in a modal dialog box with an OK button. Similar to "message box" except that the warning box uses a different icon image.

Method: warningMessageBox(string compName, string msg)

Object: com.jargonsoft.jfccomponents.utility.JFCUtility

Return: void

Param0: (compName) The name of the frame that should get focus after the user clicks the OK button.

Param1: (msg) A character string for a one-line warning message to be displayed in the message box. Cannot contain the comma (",") character.

PasswordField

Display Text
This method is used to assign a value to a PasswordField. The new value will be immediately displayed if the PasswordField is currently visible. Note: All values displayed or entered in a PasswordField are masked by displaying asterisks ("***") in place of the actual data character values.

Method: displayText(string text)

--OR--: setText(string text)

Object: com.jargonsoft.jfccomponents.JSIPasswordField

Return: void

Param0: (text) A character string to be assigned as the PasswordField value.

Get Current Value (as Character String)
These methods are used to get the character value of the current contents of a PasswordField. They all work the same and will return a value with a "string" data type.

Method: getCurrentValue()

--OR--: getCharacterValue()

--OR--: getText()

Object: com.jargonsoft.jfccomponents.JSIPasswordField

Return: string

Params: none

Assign Default Value
This method is used to assign the default value for a PasswordField.

Method: setDefaultValue(string defaultText)

Object: com.jargonsoft.jfccomponents.JSIPasswordField

Return: void

Param0: (defaultText) A character string to be assigned as a default value

Display Default Value
This method is used to set the value of a PasswordField to its default value. The new value will be immediately displayed if the PasswordField is currently visible.

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.JSIPasswordField

Return: void

Params: none

Get Font Object
This method is used to get the "font object" of a PasswordField, which can be used as a parameter to a setFont method that requires a font object. This allows easy copying of one font to multiple components. Use component.setFont(PasswordField.getFont) to copy this font to other components.

Method: getFont()

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: java.awt.Font

Params: none

Set Font
This method assigns the font used to display text values in this component. A font has three parameters (font face, style and point size). These parameters can only be specified directly for textareas and textpanes. All other components, including this one, must copy a font from another component that already has the desired font.

Method: setFont(java.awt.Font fontObject)

Object: com.jargonsoft.jfccomponents.JSIPasswordField

Return: void

Param0: (fontObject) Font object - copy from a textarea or textpane by setting up a subtask with the text object as the target and the getFont() method from the java.awt.Component class as the method. This will return a java.awt.Font object which the above method can use.

Progress Bar

Increment Progress Bar
This method is used to increment a progress bar display, to show one additional display element (square) highlighted in the bar.

Method: incrementValue()

Object: com.jargonsoft.jfccomponents.JSIProgressBar

Return: void

Params: none

Set Progress Bar Maximum
This method is used to set the maximum number of display elements (squares) in a progress bar. When the current progress bar value reaches this maximum value, subsequent attempts to increment it will do nothing.

Method: setMaximum(int nMax)

Object: com.jargonsoft.jfccomponents.JSIProgressBar

Return: void

Param0: (nMax) An integer value that is the maximum number of display elements (squares) that a progress bar can contain.

Set Progress Bar Value
This method is used to set the current integer value of a progress bar.

Method: setValue(int nVal)

Object: com.jargonsoft.jfccomponents.JSIProgressBar

Return: void

Param0: (nVal) An integer that is assigned and displayed as the current progress bar value. Must be between zero and the maximum value.

Radio Button

Select or Unselect a Radio Button
This method is used to select (bullet) or unselect (clear) a radio button.

Method: setState(boolean b)

--OR--: setSelected(boolean b)

Object: com.jargonsoft.jfccomponents.JSIRadioButton

Return: void

Param0: (b) "true" to select, "false" to unselect

Assign Default Value of a Radio Button
This method is used to assign the default state of a radio button (selected or unselected).

Method: setDefaultValue(boolean b)

Object: com.jargonsoft.jfccomponents.JSIRadioButton

Return: void

Param0: (b) "true" for selected default, "false" for unselected

Display Default Value of a Radio Button
This method is used to redisplay a radio button in its default state (selected or unselected).

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.JSIRadioButton

Return: void

Params: none

Get String Value of Current Radio Button State
This method is used to get the string value ('true' or 'false') of the current selection state of a radio button.

Method: getCurrentValue()

Object: com.jargonsoft.jfccomponents.JSIRadioButton

Return: string

Params: none

Get Boolean Value of Current Radio Button State
This method is used to get the boolean value (true or false) of the current selection state of a radio button. This method could be used as a subtask to populate a boolean parameter of another method, for example.

Method: getLogicalValue()

--OR--: getDefaultValue()

Object: com.jargonsoft.jfccomponents.JSIRadioButton

Return: string

Params: none

Change a Radio Button Label
This method is used to change the label on a radio button.

Method: setLabel(string label)

Object: javax.swing.AbstractButton

Return: void

Param0: (label) A character string to be displayed as the caption (label) of this radio button

Spinner

Get String Value of Spinner
This method is used to get the string value of the current integer value of a spinner.

Method: getText()

Object: com.jargonsoft.jfccomponents.JSISpinner

Return: string

Params: none

Get Integer Value of Current Spinner Value
This method is used to get the current integer value of a spinner. This method could be used as a subtask to populate an integer parameter of another method, for example.

Method: getIntegerValue()

Object: com.jargonsoft.jfccomponents.JSISpinner

Return: int

Params: none

Set Spinner Increment
This method is used to set the increment by which a spinner value changes when the up/down buttons are clicked.

Method: setIncrement(int nIncrement)

Object: com.jargonsoft.jfccomponents.JSISpinner

Return: void

Param0: (nIncrement) An integer value that is the increment that is added to or subtracted from the current spinner integer value when the up or down arrows are clicked.

Set Spinner Value
This method is used to set the current integer value of a spinner.

Method: setIntegerValue(int nVal)

Object: com.jargonsoft.jfccomponents.JSISpinner

Return: void

Param0: (nVal) An integer that is assigned and displayed as the current spinner value. Must be within the min/max range and must be a value that spinner can be incremented to.

Set Spinner Maximum
This method is used to set the maximum spinner value. When the spinner value reaches this value, subsequent attempts to increment it will either do nothing or "wrap" to the minimum value, depending on the value of the "Wrapable" attribute (see the method "setWrapable" below).

Method: setMax(int nMax)

Object: com.jargonsoft.jfccomponents.JSISpinner

Return: void

Param0: (nMax) An integer value that is the maximum value that a spinner can contain.

Set Spinner Minimum
This method is used to set the minimum spinner value. When the spinner value reaches this value, subsequent attempts to decrement it will either do nothing or "wrap" to the maximum value, depending on the value of the "Wrapable" attribute (see the method "setWrapable" below).

Method: setMin(int nMin)

Object: com.jargonsoft.jfccomponents.JSISpinner

Return: void

Param0: (nMin) An integer value that is the maximum value that a spinner can contain.

Set Spinner "Wrapable" Attribute
This method is used to set the "wrapable" attribute value for a spinner. When the spinner value reaches its maximum or minimum value, subsequent attempts to increment or decrement it will either do nothing or "wrap" to the opposite min/max value, depending on the value of this attribute.

Method: setWrapable(boolean b)

Object: com.jargonsoft.jfccomponents.JSISpinner

Return: void

Param0: (b) "true" to wrap from max to min and vice versa, "false" to not wrap (stop at max and stop at min).

Display Default Value
This method is used to set the value of a spinner to its default value. The new value will be immediately displayed if the spinner is currently visible.

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.JSISpinner

Return: void

Params: none

Table

Append One New Row
This method is used to add one new empty row to the bottom (end) of the table..

Method: appendRow()

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Params: none

Append Multiple New Rows
This method is used to add a specified number of new empty rows to the bottom (end) of the table..

Method: appendRow(int nRows)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nRows) An integer number of rows to append to the table.

Assign All Column Values in one Table Row
This method is used to add or change the contents of all cells in one row of a table. If the specified row number does not exist, it will be added. The value must be a delimited list of column values for every column of the row. Each column value must be a string of the appropriate data type as defined in the table column properties.

Method: displayRow(string rowData, int nRow, string delimiter)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (rowData) A list of column values, separated by commas or other specified delimiter character.

Param1: (nRow) An integer row number of the row in which to assign column values, starting with 0 (zero) for the top row. If a row number of "-1" is used, the row after the one referenced in a previous use of this method will be chosen.

Param2: (delimiter) A single character to be used to delimit values, such as a comma.

Assign a Value to one Table Cell
This method is used to assign or change the contents of one cell in a table. Both the row and column numbers must be specified, and both are numbered starting with zero (not one).

Method: displayString(string cellText, int nRow, int nCol)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (cellText) A character string to be assigned as a cell value.

Param1: (nRow) An integer row number in which to assign the cell value, starting with 0 (zero) for the top row.

Param2: (nCol) An integer column number in which to assign the cell value, starting with 0 (zero) for the leftmost column.

Start Editing Mode in a Table Cell
This method is used to put focus on and begin the editing mode in one cell in a table. Both the row and column numbers must be specified, and both are numbered starting with zero (not one).

Method: editCell(int nRow, int nCol)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nRow) An integer row number of the specified cell, starting with 0 (zero) for the top row.

Param1: (nCol) An integer column number of the specified cell, starting with 0 (zero) for the leftmost column.

Get Column Data from Selected Row
This method is used to get the current value in one table cell (a specified column in the currently selected row).

Method: getColumnDataFromSelectedRow(int nCol)

Object: com.jargonsoft.jfccomponents.JSITable

Return: string

Param0: (nCol) An integer column number to get data from (0 to n-1) in the currently selected row.

Get Data from All Rows
This method is used to get the cell values of all non-empty rows in a table. It is normally used only in host tasks when all rows of a table are being sent as a host parameter. This method uses a comma as a default delimiter in the return value, which is a complicated string of the row/column values.

Method: getDataFromAllRows()

Object: com.jargonsoft.jfccomponents.JSITable

Return: special "vector" object

Params: none

Get Data from All Rows using Special Delimiter
This method is used to get the cell values of all non-empty rows in a table. It is normally used only in host tasks when all rows of a table are being sent as a host parameter. This method uses the specified character as a delimiter in the return value, which is a complicated string of the row/column values.

Method: getDataFromAllRows(string delimiter)

Object: com.jargonsoft.jfccomponents.JSITable

Return: special "vector" object

Param0: (delimiter) The character to use as a delimiter between values. This may be necessary if the data contains commas, such as formatted numbers.

Get Data from Selected Rows
This method is used to get the cell values of all selected (highlighted) rows in a table. It is normally used only in host tasks when selected rows of a table are being sent as a host parameter. This method uses a comma as a default delimiter in the return value, which is a complicated string of the row/column values. If the selection method (see below) allows it, the user can select one row by clicking it, or select a range of rows by clicking one row and then shift-clicking the ending row of the range, or select two or more noncontiguous rows by using ctrl-click on each row.

Method: getDataFromSelectedRows()

Object: com.jargonsoft.jfccomponents.JSITable

Return: special "vector" object

Params: none

Get Data from Selected Rows using Special Delimiter
This method is used to get the cell values of all selected (highlighted) rows in a table. It is normally used only in host tasks when selected rows of a table are being sent as a host parameter. This method uses the specified character as a delimiter in the return value, which is a complicated string of the row/column values. If the selection method (see below) allows it, the user can select one row by clicking it, or select a range of rows by clicking one row and then shift-clicking the ending row of the range, or select two or more noncontiguous rows by using ctrl-click on each row.

Method: getDataFromSelectedRows(string delimiter)

Object: com.jargonsoft.jfccomponents.JSITable

Return: special "vector" object

Param0: (delimiter) The character to use as a delimiter between values. This may be necessary if the data contains commas, such as formatted numbers.

Get Data from Range of Rows
This method is used to get the cell values of a specified range of rows in a table. It can be used in host tasks to send a program-specified subset of the rows of a table as a host parameter. For example, this might be used when a table contains a very large number of rows to be sent, and it is desirable to send them in two or more host tasks. This method uses a comma as a default delimiter in the return value, which is a complicated string of the row/column values.

Method: getDataFromRangeOfRows(int fromRowNum, int thruRowNum)

Object: com.jargonsoft.jfccomponents.JSITable

Return: special "vector" object

Param0: (fromRowNum) The starting row number (note: rows start at row zero).

Param1: (thruRowNum) The ending row number from which to get cell values.

Get Data from Range of Rows using Special Delimiter
This method is used to get the cell values of a specified range of rows in a table. It can be used in host tasks to send a program-specified subset of the rows of a table as a host parameter. For example, this might be used when a table contains a very large number of rows to be sent, and it is desirable to send them in two or more host tasks. This method uses the specified character as a delimiter in the return value, which is a complicated string of the row/column values.

Method: getDataFromRangeOfRows(string delimiter, int fromRowNum, int thruRowNum)

Object: com.jargonsoft.jfccomponents.JSITable

Return: special "vector" object

Param0: (delimiter) The character to use as a delimiter between values. This may be necessary if the data contains commas, such as formatted numbers.

Param1: (fromRowNum) The starting row number (note: rows start at row zero).

Param2: (thruRowNum) The ending row number from which to get cell values.

Get Row Count
This method is used to get an integer that is the current number of rows in the table. Note that if there are 5 rows in a table, their row numbers are 0-4, so the number of rows in a table is one greater than the last row number of the table.

Method: getRowCount()

Object: com.jargonsoft.jfccomponents.JSITable

Return: int

Params: none

Get Selected Row Number
This method is used to get an integer that is the row number of the most recently selected row in the table.

Method: getSelectedRow()

Object: com.jargonsoft.jfccomponents.JSITable

Return: int

Params: none

Move Row(s)
This method is used to move a range of row numbers to a new location in the table by inserting them before a specified row number..

Method: moveRow(int nStartIndex, int nEndIndex, int nToIndex)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nStartIndex) The integer row number of the first row in the range of rows to be moved.

Param1: (nEndIndex) The integer row number of the last row in the range of rows to be moved.

Param2: (nToIndex) The integer row number of the row before which the range of rows will be moved (inserted before this row).

Remove All Rows
This method is used to remove all rows from a table and clear the row selection highlighting.

Method: removeAllItems()

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Params: none

Remove One Row
This method is used to remove a specified row from a table.

Method: removeRow(int nRow)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nRow) The integer row number to be removed.

Remove Row Selection(s)
This method is used to remove the selected (highlighted) status of a range of rows in a table. To remove selection from all rows in a table with "n" rows, use the range 0 to "n-1". While not a supported technique, it appears that you can also use 0 to "n" without causing problems.

Method: removeRowSelectionInterval(int nStartRow, int nEndRow)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nStartRow) The integer row number of the first row in the range to be de-selected.

Param1: (nEndRow) The integer row number of the last row in the range to be de-selected.

Set Column Heading
This method is used to change the column heading of a specified column to a new value. To make sure the new heading is displayed immediately, follow this method with a table.repaint method.

Method: setColumnHeading(int nColumn, string heading)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nColumn) An integer column number whose heading is to be changed.

Param1: (heading) The new column heading value.

Position Column within Viewable Area of Table
This method is used to scroll the table left or right so that the specified column is on the left, center or right of the viewable area of the table.

Method: setColumnVisible(int nCol, int nPos)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nCol) An integer column number to be positioned.

Param1: (nPos) Where to position the column: 0=left 1=center 2=right

Set Font
This method assigns the font used to display text values in this component. A font has three parameters (font face, style and point size). These parameters can only be specified directly for textareas and textpanes. All other components, including this one, must copy a font from another component that already has the desired font.

Method: setFont(java.awt.Font fontObject)

Object: javax.swing.JComponent

Return: void

Param0: (fontObject) This is a complex object that cannot be entered directly. Instead, use a subtask to apply the method getFont to a textarea or textpane that already has the desired font. The subtask will return the correct "java.awt.Font" object to supply a value for this parameter.

Position Row within Viewable Area of Table
This method is used to scroll the table up or down so that the specified row is on the top, center or bottom of the viewable area of the table.

Method: setRowVisible(int nRow, int nPos)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nRow) An integer row number to be positioned.

Param1: (nPos) Where to position the column: 0=top 1=center 2=bottom

Set Selected Row
This method is used to select (highlight) a specified row from a table.

Method: setSelectedRow(int nRow)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nRow) The integer row number to be selected.

Set Selection Method
This method is used to set the way that rows can be selected: single row, range of rows, or multiple non-contiguous rows.

Method: setSelectionMode(int nMode)

Object: javax.swing.JTable

Return: void

Param0: (nMode) An integer code for the selection model to use: 0=single row selection 1=range selection allowed 2=multiple (noncontiguous) row selection allowed

Hide Row Divider Lines
This method is used to show or hide the horizontal lines between rows. Note that this method must be applied to the table object itself. Hiding the divider lines can make for a table display that is easier to read and that looks less like a spreadsheet.

Method: setShowHorizontalLines(boolean b)

Object: javax.swing.JTable

Return: void

Param0: (b) "true" to display divider lines, "false" to hide divider lines.

Change Number of Visible Rows
This method is used to change the number of rows in the visible area of a table. If this method is used, also follow it with a pack and repaint of the frame containing the table.

Method: setVisibleRowCount(int nRows)

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Param0: (nRows) The integer number of rows to be displayed in the visible area of the table.

Stop Editing Mode
This method is used to stop (end) editing mode in any table cell that is currently in edit mode.

Method: stopEditing()

Object: com.jargonsoft.jfccomponents.JSITable

Return: void

Params: none

Textarea

Display Text
This method is used to assign a value to a textarea. The new value will be immediately displayed if the textarea is currently visible.

Method: setText(string text)

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: void

Param0: (text) A character string to be assigned as a textarea value. This value may contain line feed characters, which will override the automatic word wrap feature of the textarea, to allow user-controlled text placement (as with a name/address display).

Append Text
This method is used to append a string value to an existing value in a textarea. The new value will be immediately displayed if the textarea is currently visible.

Method: append(string text)

Object: javax.swing.JTextArea

Return: void

Param0: (text) A character string to be appended to an existing textarea value.

Get Current Value
This method is used to get the string value of the current contents of a textarea.

Method: getCurrentValue()

--OR--: getText()

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: string

Params: none

Display Default Value
This method is used to set the value of a textarea to its default value. The new value will be immediately displayed if the textarea is currently visible.

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: void

Params: none

Assign Default Value
This method is used to assign the default value for a textarea.

Method: setDefaultValue(string defaultText)

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: void

Param0: (defaultText) A character string to be assigned as a default value, which may include "\n" characters to embed newlines within the value.

Get Font Object
This method is used to get the "font object" of a textarea, which can be used as a parameter to a setFont method that requires a font object (instead of the three font attributes used in the textarea setFont method). This allows easy copying of one font to multiple components. First, use textarea.setFont(string,int,int) to set a textarea to a desired set of font attributes. Then, use component.setFont(textarea.getFont) to copy this font to other components.

Method: getFont()

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: java.awt.Font

Params: none

Set Font
This method is used to change the font being used to display the current contents of a textarea, by specifying the three attributes of a font: font name, style and point size. For additional examples, see the sample client program xml\demo\fonts.xml. Note that there is also a setFont method that takes one fontObject parameter. This other method can be used to set a textarea font by copying a font from another component (see textfield setFont method).

Method: setFont(string fontName, int nStyle, int nSize)

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: void

Param0: (fontName) Font name: Dialog, TimesRoman, Helvetica, Courier

Param1: (nStyle) Font style: 0=plain 1=bold 2=italic

Param2: (nSize) Font point size: 8, 9, 10, 11, 12 ... (etc)

Textfield

Display Text
This method is used to assign a value to a textfield. The new value will be immediately displayed if the textfield is currently visible.

Method: displayText(string text)

--OR--: setText(string text)

Object: com.jargonsoft.jfccomponents.JSITextField

Return: void

Param0: (text) A character string to be assigned as the textfield value.

Append Text
This method is used to append a string value to an existing value in a textfield. The new value will be immediately displayed if the textfield is currently visible.

Method: append(string text)

Object: com.jargonsoft.jfccomponents.JSITextField

Return: void

Param0: (text) A character string to be appended to the existing textfield value.

Add Integer Value
This method is used to add an integer value to an existing value in a textfield. Use a negative integer to subtract. The target textfield should have an "integer" data type, or this method may result in runtime errors or unexpected results. The new value will be immediately displayed if the textfield is currently visible.

Method: addIntegerValue(string nVal)

Object: com.jargonsoft.jfccomponents.JSITextField

Return: void

Param0: (nVal) An integer value to be added to the existing textfield value, which is presumed to already contain an integer value.

Get Current Value (as Character String)
These methods are used to get the character value of the current contents of a textfield. They all work the same and will return a value with a "string" data type.

Method: getCurrentValue()

--OR--: getCharacterValue()

--OR--: getText()

Object: com.jargonsoft.jfccomponents.JSITextField

Return: string

Params: none

Get Value (as other data types)
Note that similar methods can get the current value of a textfield returned as other specific data types. These methods could be used in a subtask to populate a boolean, date, decimal or integer parameter of another method, for example..

getBooleanValue() and getLogicalValue return boolean/logical(true/false)

getDateValue() returns date

getDecimalValue() returns decimal

getIntegerValue() returns integer

Get Substring
This method is used to get a substring of the character value of the current contents of a textfield.

Method: getSubstring(int nOffset, int nLength)

Object: com.jargonsoft.jfccomponents.JSITextField

Return: string

Param0: (nOffset) An integer that specifies the starting position within the textfield value, with zero (0) being the leftmost (first) character position.

Param1: (nLength) An integer that specifies the number of characters to extract as a substring of the textfield value, starting with the character in the "nOffset" position.

Get Trim Value (as Character String)
This method returns the character (string) value of a textfield, with all leading and trailing space characters removed (i.e. blanks are "trimmed off").

Method: getTrimValue()

Object: com.jargonsoft.jfccomponents.JSITextField

Return: string

Params: none

Assign Default Value
This method is used to assign the default value for a textfield.

Method: setDefaultValue(string defaultText)

Object: com.jargonsoft.jfccomponents.JSITextField

Return: void

Param0: (defaultText) A character string to be assigned as a default value

Display Default Value
This method is used to set the value of a textfield to its default value. The new value will be immediately displayed if the textfield is currently visible.

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.JSITextField

Return: void

Params: none

Get Font Object
This method is used to get the "font object" of a textfield, which can be used as a parameter to a setFont method that requires a font object. This allows easy copying of one font to multiple components. Use component.setFont(textfield.getFont) to copy this font to other components.

Method: getFont()

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: java.awt.Font

Params: none

Set Font
This method assigns the font used to display text values in this component. A font has three parameters (font face, style and point size). These parameters can only be specified directly for textareas and textpanes. All other components, including this one, must copy a font from another component that already has the desired font.

Method: setFont(java.awt.Font fontObject)

Object: javax.swing.JTextField

Return: void

Param0: (fontObject) Font object - copy from a textarea or textpane by setting up a subtask with the text object as the target and the getFont() method from the java.awt.Component class as the method. This will return a java.awt.Font object which the above method can use.

Textpane

Display Text
This method is used to assign a value to a textpane. The new value will be immediately displayed if the textpane is currently visible.

Method: setText(string text)

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: void

Param0: (text) A character string to be assigned as a textpane value. This value may contain line feed characters, which will override the automatic word wrap feature of the textpane, to allow user-controlled text placement (as with a name/address display).

Append Text
This method is used to append a string value to an existing value in a textpane. The new value will be immediately displayed if the textpane is currently visible.

Method: append(string text)

Object: javax.swing.JTextArea

Return: void

Param0: (text) A character string to be appended to an existing textarea value.

Get Current Value
This method is used to get the string value of the current contents of a textpane.

Method: getCurrentValue()

--OR--: getText()

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: string

Params: none

Assign Default Value
This method is used to assign the default value for a textpane.

Method: setDefaultValue(string defaultText)

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: void

Param0: (defaultText) A character string to be assigned as a default value, which may include "\n" characters to embed newlines within the value.

Display Default Value
This method is used to set the value of a textpane to its default value. The new value will be immediately displayed if the textpane is currently visible.

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: void

Params: none

Get Font Object
This method is used to get the "font object" of a textpane, which can be used as a parameter to a setFont method which requires a font object (instead of the three font attributes used in the textpane setFont method). This allows easy copying of one font to multiple components. First, use textpane.setFont(string,int,int) to set a textpane to a desired set of font attributes. Then, use component.setFont(textpane.getFont) to copy this font to other components.

Method: getFont()

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: java.awt.Font

Params: none

Set Font
This method is used to change the font being used to display the current contents of a textpane, by specifying the three attributes of a font: font name, style and point size. For additional examples, see the sample client program xml\demo\fonts.xml. Note that there is also a setFont method that takes one fontObject parameter. This other method can be used to set a textpane font by copying a font from another component (see the textfield setFont method).

Method: setFont(string fontName, int nStyle, int nSize)

Object: com.jargonsoft.jfccomponents.text.JSIText

Return: void

Param0: (fontName) Font name: Dialog, TimesRoman, Helvetica, Courier

Param1: (nStyle) Font style: 0=plain 1=bold 2=italic

Param2: (nSize) Font point size: 8, 9, 10, 11, 12 ... (etc)

Toggle Button

Hide the Border on a Toggle Button
This method is used to hide the border on a toggle button, such as when you want an image as a button, without a box around it.

Method: setBorderPainted(boolean b)

Object: javax.swing.AbstractButton

Return: void

Param0: (b) "true" to display a border, "false" to hide the border

Select or Unselect a Toggle Button
This method is used to select (depressed image) or unselect (normal image) a toggle button.

Method: setSelected(boolean b)

--OR--: setState(boolean b)

Object: com.jargonsoft.jfccomponents.JSIToggleButton

Return: void

Param0: (b) "true" to select, "false" to unselect

Assign Default Value of a Toggle Button
This method is used to assign the default state of a toggle button (selected or unselected).

Method: setDefaultValue(boolean b)

Object: com.jargonsoft.jfccomponents.JSIToggleButton

Return: void

Param0: (b) "true" for selected default, "false" for unselected

Display Default Value of a Toggle Button
This method is used to redisplay a toggle button in its default state (selected or unselected).

Method: displayDefaultValue()

Object: com.jargonsoft.jfccomponents.JSIToggleButton

Return: void

Params: none

Get String Value of Current Toggle Button State
This method is used to get the string value ('true' or 'false') of the current selection state of a toggle button.

Method: getCurrentValue()

Object: com.jargonsoft.jfccomponents.JSIToggleButton

Return: string

Params: none

Get Boolean Value of Current Toggle Button State
This method is used to get the boolean value (true or false) of the current selection state of a toggle button. This method could be used as a subtask to populate a boolean parameter of another method, for example.

Method: getLogicalValue()

Object: com.jargonsoft.jfccomponents.JSIToggleButton

Return: boolean

Params: none

Get Toggle Button Caption
This method is used to get the string value of the caption on a toggle button.

Method: getText()

Object: javax.swing.AbstractButton

Return: void

Params: none

Change a Toggle Button Caption
This method is used to change the caption on a toggle button.

Method: setLabel(string label)

Object: javax.swing.AbstractButton

Return: void

Param0: (label) A character string to be displayed as the caption (label) of this toggle button.

Toolbar

This component has no associated client methods.

Tree

Collapse a Node
This method is used to collapse a parent node that is currently expanded to show its child nodes, so that the child nodes are no longer displayed. After being collapsed, this node will show a "+" sign to its left, indicating that it contains one or more child nodes that are not currently visible.

Method: collapseNode(string nodeName)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (nodeName) The internal name of a tree node.

Expand a Node
This method is used to expand a collapsed parent node so that its immediate child nodes will be displayed. Note that the expansion is not recursive, meaning that this method does not expand "grandchild" nodes (nodes under any child node that has its own child nodes).

Method: expandNode(string nodeName)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (nodeName) The internal name of a tree node.

Get Image Index of a Node
This method is used to get the integer value that specifies the image filename for a specified node.

Method: getNodeImageIndex(string nodeName)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: int

Param0: (nodeName) The internal name of a tree node.

Get Text of a Node
This method is used to get the string value of the displayed text for a specified node.

Method: getNodeText(string nodeName)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: string

Param0: (nodeName) The internal name of a tree node.

Get Tooltip of a Node
This method is used to get the string value of the tooltip for a specified node.

Method: getNodeTooltip(string nodeName)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: string

Param0: (nodeName) The internal name of a tree node.

Get User Data of a Node
This method is used to get the string value of the "user data" attribute for a specified node.

Method: getNodeUserData(string nodeName)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: string

Param0: (nodeName) The internal name of a tree node.

Get Name of Currently Selected Node
This method is used to get the string value that is the internal name of the currently selected node.

Method: getSelectedNodeName()

Object: com.jargonsoft.jfccomponents.JSITTree

Return: string

Params: none

Get User Data of Currently Selected Node
This method is used to get the string value of the "user data" attribute of the currently selected node.

Method: getSelectedNodeUserData()

Object: com.jargonsoft.jfccomponents.JSITTree

Return: string

Params: none

Insert a Node
This method is used to add a node to a tree, either under the tree "root" node itself, or under any other node in the tree.

Method: insertNode(string parentNodeName, string nodeName, string nodeText, string nodeuserData, string nodeTooltip, int nImageIndex, int nNodeIndex)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (parentNodeName) The internal name of an existing node in the target tree under which the new node is to be added as a child node. This parent node may or may not already contain other child nodes. If it does, the new node will become a sibiling of the existing child nodes. Any node automatically becomes a parent node when one or more child nodes are added under it. There is no special attribute which distinguishes parent nodes from ordinary "leaf" nodes, only the fact that they contain at least one child node.

Param1: (nodeName) The internal name to assign to the new child node. (Must be unique within the client app).

Param2: (nodeText) The text to display as the caption for the new node. (Cannot be blank).

Param3: (nodeUserData) (Optional) An arbitrary character string that can be used to store any application-specific value for the new node. For example, if a tree is used as a program menu, the userdata might contain the name of the xml app to run when the node is selected.

Param4: (nodeTooltip) (Optional) A character string containing a one-line help message used as the tooltip for the new node

Param5: (nImageIndex) (Optional) An integer value which selects the icon to be displayed for the new node in the tree. Selection is from a comma-separated list of icon filenames in the tree's root node "imageList" attribute. An index of zero (0) will select the first (leftmost) image filename in the list, one (1) selects the next image filename entry, etc. If the list contains 5 image filename entries, any index value of 5 or higher will not select any image, since 0-4 select the five valid choices.

Param6: (nNodeIndex) (Optional) An integer value which specifies where to insert the new node. A value of -1 will add the new node as the last (bottom) child node for the specified parent node. A value of 0 or more will insert it before an existing child node of the parent node in that location, where 0 is the top existing node, 1 is the next node, etc.

Remove Child Nodes of a Node
This method is used to remove all child nodes under the specified parent node. This removal is recursive, so "grandchild" nodes and lower levels of nodes will also be removed.

Method: removeChildNodes(string nodeName)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (nodeName) The internal name of a tree node.

Remove a Node
This method is used to remove the specified node. This removal is recursive, so any child nodes and their children will also be removed.

Method: removeNode(string nodeName)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (nodeName) The internal name of a tree node.

Repaint a Tree
This method is used to repaint the target tree. If the text or image index of any nodes have been changed, this will redisplay the new text and images.

Method: repaint()

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Params: none

Set Image Index of a Node
This method is used to set the integer value that specifies the image filename for a specified node.

Method: setNodeImageIndex(string nodeName, int nImageIndex)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (nodeName) The internal name of a tree node.

Param1: (nImageIndex) An integer value that will become the value of the imageIndex attribute for the specified node. This value selects the icon image filename to be displayed for this node. Selection is from a comma-separated list of icon filenames in the tree's root node "imageList" attribute. An index of zero (0) will select the first (leftmost) image filename in the list, one (1) selects the next image filename entry, etc. If the list contains 5 image filename entries, any index value of 5 or higher will not select any image, since 0-4 select the five valid choices.

Set Text of a Node
This method is used to set the displayed text for a specified node.

Method: setNodeText(string nodeName, string nodeText)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (nodeName) The internal name of a tree node.

Param1: (nodeText) A character string that will become the value of the text attribute for the specified node. This is displayed as the caption for this node.

Set Tooltip of a Node
This method is used to set the tooltip for a specified node.

Method: setNodeTooltip(string nodeName, string nodeTooltip)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (nodeName) The internal name of a tree node.

Param1: (nodeTooltip) A character string that will become the value of the tooltip attribute for the specified node. This one-line help message will be displayed as the floating tooltip for this node.

Set User Data of a Node
This method is used to set the "user data" attribute for a specified node.

Method: setNodeUserData(string nodeName, string nodeData)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (nodeName) The internal name of a tree node.

Param1: (nodeData) A character string that will become the value of the "user data" attribute for the specified node.

Select a Node
This method is used to select the specified node. This will cause the specified node entry in the tree to become highlighted and will also fire the TreeSelection event.

Method: setSelectedNode(string nodeName)

Object: com.jargonsoft.jfccomponents.JSITTree

Return: void

Param0: (nodeName) The internal name of a tree node.

Up to Top Return to Help Index