Component Properties
Version 2.1

The container and component objects used to design user interfaces have a variety of properties that are different for each object class. This document lists the properties that can be used with each object, including comments and examples. These properties are accessed on the Attributes panel in the Properties Panel in the Design Window of Jargon Writer.

All properties in the Attributes panel are shown in a 2-column table as "Property" and "Value" pairs. The Value can be selected or entered in several ways, depending on the type of Property. These Value types are listed below after the name of each property. The possible value types are:

• Text - a normal textfield in which a value can be keyed directly.
• Combobox - a drop-down combo box with two or more choices.
• Boolean - a combo box with true/false choices.
• Special Editor - a display-only text string (sometimes a Java class name) with a small button at the right edge of the value field which opens a specialized editor window for this property when it is clicked. Various special editor windows are used to select images, borders, layout managers, and similar properties.

The "root" node of an application contains properties that apply to the application as a whole, not necessarily to any one container or component. Note that several properties such as HostURL and Script name that were "root" properties in Version 1 are now specified in the external "system/preferences.ini" file in Version 2.

• name (Text) The name of this app, used both internally and for the external filename: <name>.xml.
• initTasklist (Text) The name of a tasklist defined in the Task Editor window which should be run immediately after this app is loaded, before any user interaction is allowed.
• isPersistent (Boolean) If set to true, prevents automatic disposal of this app from memory when all its frames are hidden and no other apps have any references to it in any way.
• elementCount (Text) The number of "XML elements" in this app. Informational only.

• name (Text) The internal name of the object, which must be unique within this app.
• toolTipText (Text) A one-line context-sensitive help message that will be displayed when the application is run and the mouse cursor is left motionless over this object for a few seconds.
• isVisible (Boolean) Determines whether this object is displayed on the screen (true) or is hidden and only exists in memory (false).
• isEnabled (Boolean) Determines whether an object is initially enabled for input (true) or disabled to prevent user input or selection (false) when it is first created and displayed.
• foreground (special editor) Selects a foreground (text/border) color for a component, using the Color Editor window.
• background (special editor) Selects a background color for a component, using the Color Editor window.

Frame

• title (Text) The title which will be displayed in the top border of the frame when it is visible.
• isInternalFrame (Boolean) If true, this frame will be rendered (displayed) as a nested or internal frame within an InternalFrameContainer object, if one is open when this frame is being rendered. If no such InternalFrameContainer object is open at the time, the frame will be rendered as a standard standalone frame.
• isDisposalFrame (Boolean) If true, when this frame is closed its app will be disposed (flagged for removal from memory).
• isSystemExit (Boolean) If true, closing this frame will end its app and the JRE process.
• isCentered (Boolean) If true, this frame will be centered within the screen area. If false, the frame will be positioned in the upper lefthand corner of the screen.
• isCloseEnabled (Boolean) If true, the user can close this frame by clicking the "X" button in the upper right-hand corner, or choosing the "Close" choice from the frame's system menu. If false, the "X" button is grayed out, and the "Close" choice is removed from the system menu. This allows developers to prevent users from exiting (closing) a frame except by using a specific component (e.g. an "Exit" button) that can be linked to a local logic that enforces desired actions or conditions before closing the frame.
• isWarningEnabled (Boolean) If true, displays a warning message box when a frame close is attempted.
• layout (Special Editor) Specifies the Java layout manager used for this frame. Default (and only standard selection) is the java.awt.GridBagLayout.
• border (Special Editor) Specifies the border type, using the Border Editor window which is opened by clicking the small button on the right end of the value field.

• layout (Special Editor) Specifies the Java layout manager used for this panel. Default (and only standard selection) is the java.awt.GridBagLayout.
• border (Special Editor) Specifies the border type, using the Border Editor window which is opened by clicking the small button on the right end of the value field.

(same properties as Panel above)

Card Panel

(no special properties; see Common Object Properties)

Card (one of the panels in a card panel)

• layout (Special Editor) Specifies the Java layout manager used for this panel in a card panel. Default (and only standard selection) is the java.awt.GridBagLayout.
• border (Special Editor) Specifies the border type, using the Border Editor window which is opened by clicking the small button on the right end of the value field.

• tabPlacement (Combobox) Select TOP, LEFT, BOTTOM or RIGHT from the combobox to control where the tabs are positioned on the panel.

• title (Text) The caption which is displayed on the tab when the tabpanel is visible.
• icon (Special Editor) The name of an optional image file (JPEG or GIF format) which will be displayed next to the tab title on the tab when the tabpanel is visible.  The "..." button at the right edge of the image value field opens the Image editor window to browse for and select a file.
• layout (Special Editor) Specifies the Java layout manager used for this panel. Default (and only standard selection) is the java.awt.GridBagLayout.
• border (Special Editor) Specifies the border type, using the Border Editor window which is opened by clicking the small button on the right end of the value field.

(no special properties; see Common Object Properties)

InternalFrameContainer (nonvisual container for "child" frames)

(no special properties; see Common Object Properties)

Button

• label (Text) The text which will be displayed in the button when it is visible.
• mnemonic (Text) A shortcut key which works with the ALT key as a way to select this choice. If a letter is entered which is in the caption, the first occurrence of that letter (case-insensitive) will be underlined.
• horizontalTextPosition (Combobox) This combobox controls where the button caption is displayed horizontally relative to the button image. Choices are Left, Center or Right. Note that Center will overlay the image with the caption on top.
• verticalTextPosition (Combobox) This combobox controls where the button caption is displayed vertically relative to the button image. Choices are Center, Top or Bottom. Note that Center will overlay the image with the caption on top.
• horizontalAlignment (Combobox) Determines the horizontal alignment (justification) of the button caption and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Left, Center or Right.
• verticalAlignment (Combobox) Determines the horizontal alignment (justification) of the button caption and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Center, Top or Bottom.
• isSeparated (Boolean) If true, place a separator after/below this button (used in a toolbar).
• Icon Image files (Special Editor) Allows optional button image files to be displayed within the button, corresponding to different button states: icon (normal), pressedIcon, rolloverIcon and disabledIcon. The "..." button at the right edge of each image value field opens the Image editor window to browse for and select a file.

• memberList (Special Editor) Lists the toggle buttons, checkboxes and/or radio buttons that are part of this button group. Whenever one member of a button group is selected, any other previously selected member is de-selected.

• label (Text) The text which will be displayed with the checkbox image when it is visible.
• mnemonic (Text) A shortcut key which works with the ALT key as a way to select this choice. If a letter is entered which is in the caption, the first occurrence of that letter (case-insensitive) will be underlined.
• horizontalTextPosition (Combobox) This combobox controls where the checkbox caption is displayed horizontally relative to its image. Choices are Left, Center or Right. Note that Center will overlay the image with the caption on top.
• verticalTextPosition (Combobox) This combobox controls where the checkbox caption is displayed vertically relative to its image. Choices are Center, Top or Bottom. Note that Center will overlay the image with the caption on top.
• horizontalAlignment (Combobox) Determines the horizontal alignment (justification) of the checkbox caption and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Left, Center or Right.
• verticalAlignment (Combobox) Determines the horizontal alignment (justification) of the checkbox caption and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Center, Top or Bottom.
• defaultValue (Boolean) If true, display the initial state of the checkbox as selected (checked).
• Icon Image files (Special Editor) Allows optional checkbox image files to be displayed, corresponding to different checkbox states: icon (normal), pressedIcon, rolloverIcon, disabledIcon, selectedIcon, disabledSelectedIcon and rolloverSelectedIcon. The "..." button at the right edge of each image value field opens the Image editor window to browse for and select a file.

• columns (Text) An integer value used to determine the width of the combobox in "average character" units. The character used to calculate an average character's pixel width is an uppercase "P".
• imageAllowed (Boolean) If true, the list items in the combobox can also display an image.
• editable (Boolean) If true, the user can key in a value that is not in the existing list of choices.

• columns (Text) An integer value specifying the width of this combobox table column in "average character" units. The character used to calculate an average character's pixel width is an uppercase "P".
• editable (Boolean) If true, the user can key in a value that is not in the existing list of choices.
• colTitle (Text) The column title which is displayed above the column in the table, when it is visible.
• colEditable (Boolean) If true, allows the user to change the value of this column in any row.

Label

• text (Text) The text which will be displayed when the label is visible.
• horizontalAlignment (Combobox) Determines the horizontal alignment (justification) of the label text and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Left, Center or Right.
• horizontalTextPosition (Combobox) This combobox controls where the label text is displayed horizontally relative to the image (if any). Choices are Left, Center or Right. Note that Center will overlay the image with the text on top.
• verticalAlignment (Combobox) Determines the horizontal alignment (justification) of the label text and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Center, Top or Bottom.
• verticalTextPosition (Combobox) This combobox controls where the label text is displayed vertically relative to the image (if any). Choices are Center, Top or Bottom. Note that Center will overlay the image with the text on top.
• icon (Special Editor) The name of an optional image file (JPEG or GIF format) which will be displayed next to the label text when it is visible. The "..." button at the right edge of the image value field opens the Image editor window to browse for and select a file.

• columns (Text) An integer value used to determine the width of the listbox in "average character" units. The character used to calculate an average character's pixel width is an uppercase "P".
• rows (Text) An integer value specifying the number of visible rows in the listbox. If there are more list items than the number of visible rows, a vertical scroll bar (VSB) will automatically be added.

• text  (Text) The text string displayed for this combobox or listbox choice.
• icon (Special Editor) The name of an optional image file (JPEG or GIF) to be displayed next to the text for this list item. The "..." button at the right edge of the image value field opens the Image editor window to browse for and select a file.

(no special properties; see Common Object Properties)

• label (Text) The text which will be displayed as the menu choice on a menubar or submenu when it is visible.
• mnemonic (Text) A shortcut key which works with the ALT key as a way to select this choice. If a letter is entered which is in the caption, the first occurrence of that letter (case-insensitive) will be underlined.
• horizontalTextPosition (Combobox) This combobox controls where the menu caption is displayed horizontally relative to the image (if any). Choices are Left, Center or Right. Note that Center will overlay the image with the caption on top.
• verticalTextPosition (Combobox) This combobox controls where the menu caption is displayed vertically relative to the image (if any). Choices are Center, Top or Bottom. Note that Center will overlay the image with the caption on top.
• horizontalAlignment (Combobox) Determines the horizontal alignment (justification) of the menu caption and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Left, Center or Right.
• verticalAlignment (Combobox) Determines the horizontal alignment (justification) of the menu caption and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Center, Top or Bottom.
• icon (Special Editor) The name of an optional image file (JPEG or GIF format) which will be displayed next to the menu choice on the menubar when it is visible. The "..." button at the right edge of the image value field opens the Image editor window to browse for and select a file.

(same properties as Menu object)

(no special properties; see Common Object Properties)

• columns (Text) An integer value specifying the width of this special password textfield in "average character" units. The character used to calculate an average character's pixel width is an uppercase "P".
• defaultValue (Text) An optional value which will be placed in the password field when it is created and also whenever a method which resets components to their default values is invoked on it or (recursively) on its container. Note that a password field will display asterisks when a value is displayed or keyed into the textfield, to conceal the actual value for security purposes.
• maxChars (Text) An integer value specifying the maximum number of characters that can be entered into this component. A value of -1 allows unlimited entries.

(no special properties; see Common Object Properties)

(Same properties as Checkbox).

• defaultValue (Text) The initial value which will be placed in the spinner field when it is created and also whenever a method which resets components to their default values is invoked on it or (recursively) on its container.
• columns (Text) An integer value specifying the width of the text area of the spinner in "average character" units. The character used to calculate an average character's pixel width is an uppercase "P".
• editMask (Text) Any valid integer edit mask. See Textfield editMask.
• min (Text) The minimum integer value that can be selected.
• max (Text) The maximum integer value that can be selected.
• increment (Text) The integer value by which the displayed value is increased or decreased when the up or down arrow at the right of the spinner is clicked.
• wrapable (Boolean) If true, the value "wraps" from maximum to minimum or vice versa when an arrow is clicked that would decrement the value below the minimum or increment it above the maximum. If false, the value will "stick" at the min or max when it is reached.

Table

• initialRowCount (Textfield) An integer value specifying the initial total number of rows in the table, of which the "visible row count" is a subset. If another row is added when the table already has this many populated rows, this total will be automatically increased.
• rowSelectionAllowed (Boolean) If true, the rows in the table can be selected by clicking anywhere in a row.
• columnSelectionAllowed (Boolean) If true, the columns in the table can be selected by clicking anywhere in a column.
• visibleRowCount (Text) The number of rows displayed when the table is visible. If the initialRowCount is greater than the visibleRowCount, a vertical scroll bar (VSB) will be added automatically.
• visibleColumnCount (Text) The number of columns displayed when the table is visible. If the number of columns is greater than the visibleColumnCount, a horizontal scroll bar (HSB) will be added automatically.

• columns (Text) An integer value specifying the width of this textarea in "average character" units. The character used to calculate an average character's pixel width is an uppercase "P".
• rows (Text) An integer value specifying the number of text lines which will be displayed. This is used for vertical sizing.
• verticalScrollBarPolicy (Combobox) This selection controls whether a vertical scroll bar is displayed "AS NEEDED", "NEVER" or "ALWAYS".
• horizontalScrollBarPolicy (Combobox) This selection controls whether a horizontal scroll bar is displayed "AS NEEDED", "NEVER" or "ALWAYS".
• lineWrap (Boolean) If true, the textarea will have automatic line wrap (on whole word boundaries) when data is entered or displayed in this textarea. If false, no automatic line wrapping is done, and the Enter key must be used to start a new line.
• text (Text) An optional value which will be placed in the textarea when it is created and also whenever a method which resets components to their default values is invoked on it or (recursively) on its container.
• maxChars (Text) An integer value specifying the maximum number of characters that can be entered into this component. A value of -1 allows unlimited entries. Note that pressing the "Enter" key counts as two characters (CR and LF) against this limit.

TextCellEditor

• columns (Text) An integer value specifying the width of this text table column in "average character" units. The character used to calculate an average character's pixel width is an uppercase "P".
• fieldType (Combobox) Selects the type of data allowed in this textfield cell: Character, Integer, Decimal, Date or Logical. This field type choice determines the data type that will be used for the corresponding temp-table field in the generated 4GL program when this table cell is used as a host task parameter.
• editMask (Text) See Textfield editMask.
• colTitle (Text) The column title which is displayed above the column in the table, when it is visible.
• colEditable (Boolean) If true, allows the user to change the value of this column in any row.
• alignment (Combobox) Select "left", "center" or "right" to control whether characters are entered and displayed left flush, centered or right flush within this text table column.

Textfield

• columns (Text) An integer value specifying the width of this textfield in "average character" units. The character used to calculate an average character's pixel width is an uppercase "P".
• fieldType (Combobox) Selects the type of data allowed in this textfield: Character, Integer, Decimal, Date or Logical. This field type choice determines the data type that will be used for the corresponding variable in the generated 4GL program when this textfield is used as a host task parameter.
• editMask (Text) This is an optional edit mask format modeled after Progress data formats. If a mask format is used, it will display data values according to the mask format, and will restrict data entry to the number and type of characters in the mask. For example, a character mask of "X(20)" will allow entry of any character, but no more than 20 of them. A decimal mask of ">>9.99" will allow only the digits 0 to 9 or a decimal point, with up to 3 digits before the decimal point and up to 2 digits after it. This feature allows you to enforce compatibility with Progress data entry formats, which can be especially helpful if both character terminals and GUI clients have access to procedures which update the same database fields.

  Edit mask syntax and functionality is the same as for Progress 4GL "formats", with the one general exception that all character representation symbols must be in UPPER CASE ("X(20)", "ZZ9", etc.) and with the following specific exceptions for each data type:

  • Character: Spaces are allowed in "N", "A" and "!" formats, since Progress's design for these formats is flawed (in our opinion).
  • Date: The only available format is "MM/DD/YYYY", which is automatically selected and enforced. The user may still enter a 2-digit year value during data entry, and the century digits will be automatically inserted based on a 100-year rolling century window. The default century window is 1950-2049, meaning that an entry of 01/01/50 defaults to 01/01/1950 and 12/31/49 defaults to 12/31/2049. The starting year of the century window may be overridden in the preference.ini files (feature not yet implemented).
  • Decimal: The "DR", "DB" and "CR" positive/negative indicator strings are not supported.
  • Integer: The "DR", "DB" and "CR" positive/negative indicator strings are not supported.
  • Logical: Identical to Progress formats.
  
   
• defaultValue (Text) The initial value which will be placed in the textfield when it is created and also whenever a method which resets components to their default values is invoked on it or (recursively) on its container.
• maxChars (Text) An integer value specifying the maximum number of characters that can be entered into this component. A value of -1 allows unlimited entries.

• columns (Text) An integer value specifying the width of this textpane in "average character" units. The character used to calculate an average character's pixel width is an uppercase "P".
• rows (Text) An integer value specifying the number of text lines which will be displayed. This is used for vertical sizing.
• text (Text) An optional value which will be placed in the textpane when it is created and also whenever a method which resets components to their default values is invoked on it or (recursively) on its container.

• label (Text) The text which will be displayed in the button when it is visible.
• mnemonic (Text) A shortcut key which works with the ALT key as a way to select this choice. If a letter is entered which is in the caption, the first occurrence of that letter (case-insensitive) will be underlined.
• horizontalTextPosition (Combobox) This combobox controls where the button caption is displayed horizontally relative to the button image. Choices are Left, Center or Right. Note that Center will overlay the image with the caption on top.
• verticalTextPosition (Combobox) This combobox controls where the button caption is displayed vertically relative to the button image. Choices are Center, Top or Bottom. Note that Center will overlay the image with the caption on top.
• horizontalAlignment (Combobox) Determines the horizontal alignment (justification) of the button caption and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Left, Center or Right.
• verticalAlignment (Combobox) Determines the horizontal alignment (justification) of the button caption and image within its boundaries. This is only useful if it has a size larger than its contents, such as by using Fill layout properties. Choices are Center, Top or Bottom.
• defaultValue (Boolean) If true, display the initial state of the toggle button as selected (depressed).
• isSeparated (Boolean) If true, place a separator after/below this button (used in a toolbar).
• Icon Image files (Special Editor) Allows optional button image files to be displayed within the button, corresponding to different button states: icon (normal), pressedIcon, rolloverIcon, disabledIcon, selectedIcon, disabledSelectedIcon and rolloverSelectedIcon. The "..." button at the right edge of each image value field opens the Image editor window to browse for and select a file.

(no special properties; see Common Object Properties)

Tree

• Initial Width (int) The initial width (in pixels) of the tree.
• Initial Height (int) The initial height (in pixels) of the tree.
• rootText (String) The text label on the root node of the tree.
• rootImageIndex (int) 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.
• rootUserData (String) An arbitrary character string that can be used to store any application-specific value for this 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.
• rootTooltipText (String) The help message to display in floating tooltip help.
• isRootVisible (boolean) Should the root node be displayed in the tree (true/false)?
• imageList (String) A comma-separated list of image filenames (relative to the image root directory specified in the MediaRootDir or MediaRootURL parameter). The first entry is selected by setting ImageIndex=0, the second by ImageIndex=1, etc.

TreeNode

• text (String) The text label displayed for this tree node.
• imageIndex (int) 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.
• userData (String) An arbitrary character string that can be used to store any application-specific value for this 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.