aejaks.sourceforge.net

Manual

Echo2 documentation (Javadocs) should be consulted for further reference.

Attribute objects

• Alignment
• AwtImageReference
• Border
• Char
• Color
• DerivedMutableStyle
• Extent
• FillImageBorder
• FillImage
• Font
• HttpImageReference
• ImageReference
• Insets
• LayoutDirection
• MutableStyleSheet
• MutableStyle
• ResourceImageReference
• StreamImageReference
  

Layout Data Objects

• AccordionPaneLayoutData
• ColumnLayoutData
• DisplayLayoutData
• GridLayoutData
• LayoutData
• RowLayoutData
• ScrollableDisplayLayoutData
• SplitPaneLayoutData
• TableLayoutData
• TabPaneLayoutData
  

Containers

• AccordionPane
• BorderPane
• Column
• ContainerEx
• ContentPane
• ContentPaneEx
• DragSource
• ExpandableSection
• Grid
• GroupBox
• MenuBarPane
• Panel
• Row
• SplitPane
• TabPane
• TransitionPane
• WindowPane
• Window
  

Widget Components

• AbleProperties
• ApplicationInstance
• Button
• CalendarSelect
• ChartDisplay
• CheckBox
• ColorSelect
• ComboBox
• Component
• DirectHtml
• DropDownMenu
• Label
• ListBox
• Menu
• PasswordField
• ProgressBar
• RadioButton
• RichTextArea
• SelectField
• Slider
• Strut
• Table
• TextArea
• TextField
• TextFieldEx
• UploadSelect
  

Commands

• BrowserCommand
• Download
• Log
• Pack
• TaskQueue
  

Library

• aejaks_chooseColor
• aejaks_chooseDate
• aejaks_entryBox
• aejaks_getFile
• aejaks_messageBox
• aejaks_bgerror
  

---

Object References

---

AbleProperties

Inherits from Component

Properties

• -accessKey
• -alignment
• -backgroundImage
• -border
• -height
• -hidden
• -insets
• -mouseCursor
• -mouseCursorUri
• -outsets
• -toolTipText
• -width
  

Class Procedures

• _getObjType_ {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAccessKey {}
• getAlignment {}
• getAttribute {String1}
• getAttributeNames {}
• getBackgroundImage {}
• getBorder {}
• getHeight {}
• getInsets {}
• getMouseCursor {}
• getMouseCursorUri {}
• getOutsets {}
• getToolTipText {}
• getWidth {}
• hashCode {}
• isHidden {}
• setAccessKey {String1}
• setAlignment {Alignment1}
• setAttribute {String1 Object2}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setHeight {Extent1}
• setHidden {boolean1}
• setInsets {Insets1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
  

Notes

AbleProperties is a collection of property objects used by certain methods in TextFieldEx.

Goto Top

---

AccordionPaneLayoutData

Properties

• -title
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getTitle {}
• hashCode {}
• setTitle {String1}
• toString {}
  

Notes

This object is automatically created when using the Pack command, and is listed here for reference.

Goto Top

---

AccordionPane

Inherits from Component

Properties

• -activeTabIndex
• -defaultContentInsets
• -tabBackground
• -tabBackgroundImage
• -tabBorder
• -tabForeground
• -tabInsets
• -tabRolloverBackground
• -tabRolloverBackgroundImage
• -tabRolloverBorder
• -tabRolloverEnabled
• -tabRolloverForeground
  

Class Procedures

• _getObjType_ {}
• INPUT_TAB_INDEX {}
• ACTIVE_TAB_INDEX_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getActiveTabIndex {}
• getDefaultContentInsets {}
• getTabBackground {}
• getTabBackgroundImage {}
• getTabBorder {}
• getTabForeground {}
• getTabInsets {}
• getTabRolloverBackground {}
• getTabRolloverBackgroundImage {}
• getTabRolloverBorder {}
• getTabRolloverForeground {}
• hashCode {}
• isTabRolloverEnabled {}
• setActiveTabIndex {int1}
• setDefaultContentInsets {Insets1}
• setTabBackground {Color1}
• setTabBackgroundImage {FillImage1}
• setTabBorder {Border1}
• setTabForeground {Color1}
• setTabInsets {Insets1}
• setTabRolloverBackground {Color1}
• setTabRolloverBackgroundImage {FillImage1}
• setTabRolloverBorder {Border1}
• setTabRolloverEnabled {boolean1}
• setTabRolloverForeground {Color1}
• toString {}
  

Goto Top

---

Alignment

Constructor Arguments

horizontalSpec verticalSpec

Where:

• horizontalSpec is one of: DEFAULT LEADING TRAILING LEFT CENTER RIGHT
• verticalSpec is one of: DEFAULT TOP CENTER BOTTOM
  

Properties

Class Procedures

• _getObjType_ {}
• ALIGN_LEFT {}
• ALIGN_CENTER {}
• ALIGN_RIGHT {}
• ALIGN_TOP {}
• ALIGN_BOTTOM {}
• DEFAULT {}
• LEADING {}
• TRAILING {}
• LEFT {}
• CENTER {}
• RIGHT {}
• TOP {}
• BOTTOM {}
• _newObj_ {args}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getHorizontal {}
• getVertical {}
• hashCode {}
• toString {}
  

Notes

horizontalSpec and verticalSpec may be specifed in lower-case.

Goto Top

---

ApplicationInstance

Properties

• -focusedComponent
• -locale
• -styleSheet
  

Class Procedures

• _getObjType_ {}
• ID_STRING {}
• FOCUSED_COMPONENT_CHANGED_PROPERTY {}
• LOCALE_CHANGED_PROPERTY {}
• MODAL_COMPONENTS_CHANGED_PROPERTY {}
• WINDOWS_CHANGED_PROPERTY {}
• generateSystemId {}
• getActive {}
• setActive {ApplicationInstance1}
  

Methods

• _getObj_ {}
• _getType_ {}
• activate {}
• addPropertyChangeListener {PropertyChangeListener1}
• createTaskQueue {}
• dispose {}
• doInit {}
• doValidation {}
• enqueueCommand {Command1}
• enqueueTask {TaskQueueHandle1 Runnable2}
• equals {Object1}
• generateId {}
• getComponentByRenderId {String1}
• getContextProperty {String1}
• getDefaultWindow {}
• getFocusedComponent {}
• getLayoutDirection {}
• getLocale {}
• getModalContextRoot {}
• getStyle {Class1 String2}
• getStyleSheet {}
• getUpdateManager {}
• hasQueuedTasks {}
• hasTaskQueues {}
• hashCode {}
• init {}
• passivate {}
• processInput {String1 Object2}
• processQueuedTasks {}
• removePropertyChangeListener {PropertyChangeListener1}
• removeTaskQueue {TaskQueueHandle1}
• setContextProperty {String1 Object2}
• setFocusedComponent {Component1}
• setLocale {Locale1}
• setStyleSheet {StyleSheet1}
• toString {}
  

Notes

ApplicationInstance cannot be instantiated. Instead, the Java object reference can be retrieved from the root window "." through use of the getThisAppObj method.

Use of this object is discouraged, as other commands and objects manipulate the ApplicationInstance as required.

Goto Top

---

AwtImageReference

Properties

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getHeight {}
• getImage {}
• getRenderId {}
• getWidth {}
• hashCode {}
• toString {}
  

Notes

Creating this object should be done through the ImageReference object;

Goto Top

---

BorderPane

Inherits from Component

Properties

• -border
• -insets
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getBorder {}
• getInsets {}
• hashCode {}
• setBorder {FillImageBorder1}
• setInsets {Insets1}
• toString {}
  

Goto Top

---

Border

Constructor Arguments

size color style

Where:

• size is a valid Extent constructor argument or object
• color is a valid Color constructor argument or object
• style is one of: NONE SOLID INSET OUTSET GROOVE RIDGE DOUBLE DOTTED DASHED
  

Properties

Class Procedures

• _getObjType_ {}
• STYLE_NONE {}
• STYLE_SOLID {}
• STYLE_INSET {}
• STYLE_OUTSET {}
• STYLE_GROOVE {}
• STYLE_RIDGE {}
• STYLE_DOUBLE {}
• STYLE_DOTTED {}
• STYLE_DASHED {}
• _newObj_ {args}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getColor {}
• getSize {}
• getStyle {}
• hashCode {}
• toString {}
  

Notes

style may be specified in lower-case.

Goto Top

---

Button

Inherits from Component

Properties

• -alignment
• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledBorder
• -disabledFont
• -disabledForeground
• -disabledIcon
• -height
• -icon
• -iconTextMargin
• -insets
• -lineWrap
• -pressedBackground
• -pressedBackgroundImage
• -pressedBorder
• -pressedEnabled
• -pressedFont
• -pressedForeground
• -pressedIcon
• -rolloverBackground
• -rolloverBackgroundImage
• -rolloverBorder
• -rolloverEnabled
• -rolloverFont
• -rolloverForeground
• -rolloverIcon
• -text
• -textAlignment
• -textPosition
• -toolTipText
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• INPUT_CLICK {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• doAction {}
• equals {Object1}
• fireActionPerformed {ActionEvent1}
• getAlignment {}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getDisabledIcon {}
• getHeight {}
• getIcon {}
• getIconTextMargin {}
• getInsets {}
• getPressedBackground {}
• getPressedBackgroundImage {}
• getPressedBorder {}
• getPressedFont {}
• getPressedForeground {}
• getPressedIcon {}
• getRolloverBackground {}
• getRolloverBackgroundImage {}
• getRolloverBorder {}
• getRolloverFont {}
• getRolloverForeground {}
• getRolloverIcon {}
• getText {}
• getTextAlignment {}
• getTextPosition {}
• getToolTipText {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• isLineWrap {}
• isPressedEnabled {}
• isRolloverEnabled {}
• setAlignment {Alignment1}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setDisabledIcon {ImageReference1}
• setHeight {Extent1}
• setIcon {ImageReference1}
• setIconTextMargin {Extent1}
• setInsets {Insets1}
• setLineWrap {boolean1}
• setPressedBackground {Color1}
• setPressedBackgroundImage {FillImage1}
• setPressedBorder {Border1}
• setPressedEnabled {boolean1}
• setPressedFont {Font1}
• setPressedForeground {Color1}
• setPressedIcon {ImageReference1}
• setRolloverBackground {Color1}
• setRolloverBackgroundImage {FillImage1}
• setRolloverBorder {Border1}
• setRolloverEnabled {boolean1}
• setRolloverFont {Font1}
• setRolloverForeground {Color1}
• setRolloverIcon {ImageReference1}
• setText {String1}
• setTextAlignment {Alignment1}
• setTextPosition {Alignment1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
  

Goto Top

---

CalendarSelect

Inherits from Component

Properties

• -adjacentMonthDateForeground
• -backgroundImage
• -border
• -date
• -selectedDateBackground
• -selectedDateBackgroundImage
• -selectedDateForeground
  

Class Procedures

• _getObjType_ {}
• DATE_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAdjacentMonthDateForeground {}
• getBackgroundImage {}
• getBorder {}
• getDate {}
• getSelectedDateBackground {}
• getSelectedDateBackgroundImage {}
• getSelectedDateForeground {}
• hashCode {}
• setAdjacentMonthDateForeground {Color1}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDate {Date1}
• setSelectedDateBackground {Color1}
• setSelectedDateBackgroundImage {FillImage1}
• setSelectedDateForeground {Color1}
• toString {}
  

Goto Top

---

CellLayoutData

Properties

• -alignment
• -background
• -backgroundImage
• -insets
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getAlignment {}
• getBackground {}
• getBackgroundImage {}
• getInsets {}
• hashCode {}
• setAlignment {Alignment1}
• setBackground {Color1}
• setBackgroundImage {FillImage1}
• setInsets {Insets1}
• toString {}
  

Notes

This object is automatically created when using the Pack command, and is listed here for reference.

Goto Top

---

Char

Properties

Class Procedures

• getChar {n}
• getDescription {n}
• getCharNames {}
• getAllChars {}
• getAllDescriptions {}
  

Methods

Notes

Char provides shortcuts to commonly used character entities. The Char object cannot be instantiated, instead static procedures are used.

Examples:

Label .l -text "Welcome to [Char::getChar AElig]jaks!"

foreach charName [Char::getCharNames] {

    puts "char name: $charName description: [Char::getDescription $charName]"

}

Goto Top

---

ChartDisplay

Inherits from Component

Properties

• -chart
• -height
• -width
  

Class Procedures

• _getObjType_ {}
• CHART_CHANGED_PROPERTY {}
• CHART_CONTENT_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getChart {}
• getHeight {}
• getWidth {}
• hashCode {}
• setChart {JFreeChart1}
• setHeight {Extent1}
• setWidth {Extent1}
• toString {}
  

Notes

The ChartDisplay widget uses JFreeChart as the underlying charting engine. For more information, including Java API documentation, see jfree.org

Goto Top

---

CheckBox

Inherits from Component

Properties

• -alignment
• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledBorder
• -disabledFont
• -disabledForeground
• -disabledIcon
• -height
• -icon
• -iconTextMargin
• -insets
• -lineWrap
• -pressedBackground
• -pressedBackgroundImage
• -pressedBorder
• -pressedEnabled
• -pressedFont
• -pressedForeground
• -pressedIcon
• -pressedSelectedStateIcon
• -pressedStateIcon
• -rolloverBackground
• -rolloverBackgroundImage
• -rolloverBorder
• -rolloverEnabled
• -rolloverFont
• -rolloverForeground
• -rolloverIcon
• -rolloverSelectedStateIcon
• -rolloverStateIcon
• -selected
• -selectedStateIcon
• -stateAlignment
• -stateIcon
• -stateMargin
• -statePosition
• -text
• -textAlignment
• -textPosition
• -toolTipText
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• SELECTED_CHANGED_PROPERTY {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• INPUT_CLICK {}
  

Methods

• _getObj_ {}
• _getType_ {}
• addChangeListener {ChangeListener1}
• dispose {}
• doAction {}
• equals {Object1}
• fireActionPerformed {ActionEvent1}
• fireStateChanged {}
• getAlignment {}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getDisabledIcon {}
• getHeight {}
• getIcon {}
• getIconTextMargin {}
• getInsets {}
• getPressedBackground {}
• getPressedBackgroundImage {}
• getPressedBorder {}
• getPressedFont {}
• getPressedForeground {}
• getPressedIcon {}
• getPressedSelectedStateIcon {}
• getPressedStateIcon {}
• getRolloverBackground {}
• getRolloverBackgroundImage {}
• getRolloverBorder {}
• getRolloverFont {}
• getRolloverForeground {}
• getRolloverIcon {}
• getRolloverSelectedStateIcon {}
• getRolloverStateIcon {}
• getSelectedStateIcon {}
• getStateAlignment {}
• getStateIcon {}
• getStateMargin {}
• getStatePosition {}
• getText {}
• getTextAlignment {}
• getTextPosition {}
• getToolTipText {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• isLineWrap {}
• isPressedEnabled {}
• isRolloverEnabled {}
• isSelected {}
• removeChangeListener {ChangeListener1}
• setAlignment {Alignment1}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setDisabledIcon {ImageReference1}
• setHeight {Extent1}
• setIcon {ImageReference1}
• setIconTextMargin {Extent1}
• setInsets {Insets1}
• setLineWrap {boolean1}
• setPressedBackground {Color1}
• setPressedBackgroundImage {FillImage1}
• setPressedBorder {Border1}
• setPressedEnabled {boolean1}
• setPressedFont {Font1}
• setPressedForeground {Color1}
• setPressedIcon {ImageReference1}
• setPressedSelectedStateIcon {ImageReference1}
• setPressedStateIcon {ImageReference1}
• setRolloverBackground {Color1}
• setRolloverBackgroundImage {FillImage1}
• setRolloverBorder {Border1}
• setRolloverEnabled {boolean1}
• setRolloverFont {Font1}
• setRolloverForeground {Color1}
• setRolloverIcon {ImageReference1}
• setRolloverSelectedStateIcon {ImageReference1}
• setRolloverStateIcon {ImageReference1}
• setSelected {boolean1}
• setSelectedStateIcon {ImageReference1}
• setStateAlignment {Alignment1}
• setStateIcon {ImageReference1}
• setStateMargin {Extent1}
• setStatePosition {Alignment1}
• setText {String1}
• setTextAlignment {Alignment1}
• setTextPosition {Alignment1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
  

Goto Top

---

ColorSelect

Inherits from Component

Properties

• -color
• -displayValue
• -hueWidth
• -saturationHeight
• -valueWidth
  

Class Procedures

• _getObjType_ {}
• COLOR_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getColor {}
• getHueWidth {}
• getSaturationHeight {}
• getValueWidth {}
• hashCode {}
• isDisplayValue {}
• setColor {Color1}
• setDisplayValue {boolean1}
• setHueWidth {Extent1}
• setSaturationHeight {Extent1}
• setValueWidth {Extent1}
• toString {}
  

Goto Top

---

Color

Constructor Arguments

integer-value
or
hex-value
or
red-integer green-integer blue-integer
or
color-name

Where:

• integer-value is a integer from 0 - 16,777,215, specifing red, green, and blue values
• hex-value is a hexadecimal value #000000 to #ffffff
• red-integer green-integer blue-integer are red, green, blue values, each 0 - 255
• color-name is a recognized color name. X11 rgb.txt and common HTML colors are defined.
  

Properties

Class Procedures

• _getObjType_ {}
• _newObj_ {args}
• getColorNames {{colorNames "*"}}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getBlue {}
• getGreen {}
• getRed {}
• getRgb {}
• hashCode {}
• toString {}
  

Notes

The colorNames argument of getColorNames may contain '*" wildchars, e.g., Color::getColorNames *white*

Goto Top

---

ColumnLayoutData

Properties

• -alignment
• -background
• -backgroundImage
• -height
• -insets
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getAlignment {}
• getBackground {}
• getBackgroundImage {}
• getHeight {}
• getInsets {}
• hashCode {}
• setAlignment {Alignment1}
• setBackground {Color1}
• setBackgroundImage {FillImage1}
• setHeight {Extent1}
• setInsets {Insets1}
• toString {}
  

Notes

This object is automatically created when using the Pack command, and is listed here for reference.

Goto Top

---

Column

Inherits from Component

Properties

• -border
• -cellSpacing
• -insets
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getBorder {}
• getCellSpacing {}
• getInsets {}
• hashCode {}
• setBorder {Border1}
• setCellSpacing {Extent1}
• setInsets {Insets1}
• toString {}
  

Goto Top

---

ComboBox

Inherits from Component

Properties

• -accessKey
• -actionOnSelection
• -autoRecall
• -autoRecallLimit
• -border
• -caseSensitive
• -expanded
• -expansionGroup
• -expansionModel
• -focusComponent
• -height
• -hidden
• -insets
• -listCellRenderer
• -listRowCount
• -mouseCursor
• -mouseCursorUri
• -outsets
• -popUp
• -popUpAlignment
• -popUpAlwaysOnTop
• -popUpBackground
• -popUpBorder
• -popUpInsets
• -popUpLeftOffset
• -popUpNextToToggle
• -popUpOnRollover
• -popUpOutsets
• -popUpTopOffset
• -rolloverBackground
• -rolloverBorder
• -rolloverEnabled
• -target
• -targetBackground
• -targetBorder
• -targetInsets
• -targetRolloverBackground
• -targetRolloverBorder
• -text
• -textField
• -textMatchingPerformed
• -toggleBackground
• -toggleBorder
• -toggleIcon
• -toggleInsets
• -togglePressedBackground
• -togglePressedBorder
• -togglePressedEnabled
• -togglePressedIcon
• -toggleRolloverBackground
• -toggleRolloverBorder
• -toggleRolloverIcon
• -toolTipText
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• DEFAULT_TEXT_FIELD_STYLE {}
• DEFAULT_ALIGNMENT {}
• DEFAULT_STYLE {}
• DEFAULT_ALIGNMENT echopointng.PopUp {}
• DEFAULT_STYLE echopointng.PopUp {}
• DEFAULT_TOGGLE_ICON {}
• DEFAULT_TOGGLE_ROLLOVER_ICON {}
• DEFAULT_TOGGLE_PRESSED_ICON {}
• EXPANDED_CHANGED_PROPERTY {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAccessKey {}
• getAttribute {String1}
• getAttributeNames {}
• getAutoRecallLimit {}
• getBorder {}
• getExpansionGroup {}
• getExpansionModel {}
• getFocusComponent {}
• getHeight {}
• getInsets {}
• getListCellRenderer {}
• getListRowCount {}
• getMouseCursor {}
• getMouseCursorUri {}
• getOutsets {}
• getPopUp {}
• getPopUpAlignment {}
• getPopUpAlwaysOnTop {}
• getPopUpBackground {}
• getPopUpBorder {}
• getPopUpInsets {}
• getPopUpLeftOffset {}
• getPopUpOutsets {}
• getPopUpTopOffset {}
• getRolloverBackground {}
• getRolloverBorder {}
• getTarget {}
• getTargetBackground {}
• getTargetBorder {}
• getTargetInsets {}
• getTargetRolloverBackground {}
• getTargetRolloverBorder {}
• getText {}
• getTextField {}
• getToggleBackground {}
• getToggleBorder {}
• getToggleIcon {}
• getToggleInsets {}
• getTogglePressedBackground {}
• getTogglePressedBorder {}
• getTogglePressedIcon {}
• getToggleRolloverBackground {}
• getToggleRolloverBorder {}
• getToggleRolloverIcon {}
• getToolTipText {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• isActionOnSelection {}
• isAutoRecall {}
• isCaseSensitive {}
• isExpanded {}
• isHidden {}
• isPopUpNextToToggle {}
• isPopUpOnRollover {}
• isRolloverEnabled {}
• isTextMatchingPerformed {}
• isTogglePressedEnabled {}
• setAccessKey {String1}
• setActionOnSelection {boolean1}
• setAttribute {String1 Object2}
• setAutoRecall {boolean1}
• setAutoRecallLimit {int1}
• setBorder {Border1}
• setCaseSensitive {boolean1}
• setExpanded {boolean1}
• setExpansionGroup {ExpansionGroup1}
• setExpansionModel {ExpansionModel1}
• setFocusComponent {Component1}
• setFocusOnExpand {boolean1}
• setHeight {Extent1}
• setHidden {boolean1}
• setInsets {Insets1}
• setListCellRenderer {ListCellRenderer1}
• setListRowCount {int1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setPopUp {Component1}
• setPopUpAlignment {Alignment1}
• setPopUpAlwaysOnTop {boolean1}
• setPopUpBackground {Color1}
• setPopUpBorder {Border1}
• setPopUpInsets {Insets1}
• setPopUpLeftOffset {int1}
• setPopUpNextToToggle {boolean1}
• setPopUpOnRollover {boolean1}
• setPopUpOutsets {Insets1}
• setPopUpTopOffset {int1}
• setRolloverBackground {Color1}
• setRolloverBorder {Border1}
• setRolloverEnabled {boolean1}
• setTarget {Component1}
• setTargetBackground {Color1}
• setTargetBorder {Border1}
• setTargetInsets {Insets1}
• setTargetRolloverBackground {Color1}
• setTargetRolloverBorder {Border1}
• setText {String1}
• setTextField {TextField1}
• setTextMatchingPerformed {boolean1}
• setToggleBackground {Color1}
• setToggleBorder {Border1}
• setToggleIcon {ImageReference1}
• setToggleInsets {Insets1}
• setTogglePressedBackground {Color1}
• setTogglePressedBorder {Border1}
• setTogglePressedEnabled {boolean1}
• setTogglePressedIcon {ImageReference1}
• setToggleRolloverBackground {Color1}
• setToggleRolloverBorder {Border1}
• setToggleRolloverIcon {ImageReference1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
• insert {start args}
• get {start {end ""}}
• remove {start {end ""}}
• removeAll {}
• size {}
• getSelectedItem {}
  

Goto Top

---

Component

Properties

• -background
• -enabled
• -focusTraversalIndex
• -focusTraversalParticipant
• -font
• -foreground
• -id
• -layoutData
• -layoutDirection
• -locale
• -renderId
• -style
• -styleName
• -visible
  

Class Procedures

• _getObjType_ {}
• CHILDREN_CHANGED_PROPERTY {}
• ENABLED_CHANGED_PROPERTY {}
• FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY {}
• FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY {}
• LAYOUT_DIRECTION_CHANGED_PROPERTY {}
• LOCALE_CHANGED_PROPERTY {}
• STYLE_CHANGED_PROPERTY {}
• STYLE_NAME_CHANGED_PROPERTY {}
• VISIBLE_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• add {args}
• addPropertyChangeListener {args}
• dispose {}
• equals {Object1}
• getApplicationInstance {}
• getBackground {}
• getComponent {args}
• getComponentCount {}
• getComponents {}
• getFocusTraversalIndex {}
• getFont {}
• getForeground {}
• getId {}
• getIndexedProperty {String1 int2}
• getLayoutData {}
• getLayoutDirection {}
• getLocale {}
• getParent {}
• getProperty {String1}
• getRenderId {}
• getRenderIndexedProperty {args}
• getRenderLayoutDirection {}
• getRenderLocale {}
• getRenderProperty {args}
• getStyle {}
• getStyleName {}
• getVisibleComponent {int1}
• getVisibleComponentCount {}
• getVisibleComponents {}
• hashCode {}
• indexOf {Component1}
• init {}
• isAncestorOf {Component1}
• isEnabled {}
• isFocusTraversalParticipant {}
• isRegistered {}
• isRenderEnabled {}
• isRenderVisible {}
• isValidChild {Component1}
• isValidParent {Component1}
• isVisible {}
• processInput {String1 Object2}
• remove {args}
• removeAll {}
• removePropertyChangeListener {args}
• setBackground {Color1}
• setEnabled {boolean1}
• setFocusTraversalIndex {int1}
• setFocusTraversalParticipant {boolean1}
• setFont {Font1}
• setForeground {Color1}
• setId {String1}
• setIndexedProperty {String1 int2 Object3}
• setLayoutData {LayoutData1}
• setLayoutDirection {LayoutDirection1}
• setLocale {Locale1}
• setProperty {String1 Object2}
• setRenderId {String1}
• setStyle {Style1}
• setStyleName {String1}
• setVisible {boolean1}
• toString {}
• validate {}
• verifyInput {String1 Object2}
• visibleIndexOf {Component1}
  

Notes

This class cannot be instantiated. It serves as the base class to many other components.

If configuring -renderId on a component (or if invokding setRenderId), the value for the renderId must be alphanumeric characters only, and must begin with an alpha character.

Goto Top

---

Composite

Inherits from Component

Properties

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• hashCode {}
• toString {}
  

Notes

This class cannot be instantiated. It serves as the base class to the Panel container.

Goto Top

---

ContainerEx

Inherits from Component

Properties

• -accessKey
• -backgroundImage
• -border
• -bottom
• -height
• -heightStretched
• -hidden
• -horizontalScroll
• -insets
• -left
• -maximumStretchedHeight
• -minimumStretchedHeight
• -mouseCursor
• -mouseCursorUri
• -outsets
• -position
• -right
• -scrollBarBaseColor
• -scrollBarPolicy
• -scrollBarProperties
• -toolTipText
• -top
• -verticalScroll
• -width
• -zIndex
  

Class Procedures

• _getObjType_ {}
• DEFAULT_STYLE {}
• STATIC {}
• ABSOLUTE {}
• RELATIVE {}
• FIXED {}
• UNDEFINED {}
• NEVER {}
• ALWAYS {}
• AUTO {}
• CLIPHIDE {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
  

Methods

• _getObj_ {}
• _getType_ {}
• clear {}
• dispose {}
• equals {Object1}
• getAccessKey {}
• getAttribute {String1}
• getAttributeNames {}
• getBackgroundImage {}
• getBorder {}
• getBottom {}
• getHeight {}
• getHorizontalScroll {}
• getInsets {}
• getLeft {}
• getMaximumStretchedHeight {}
• getMinimumStretchedHeight {}
• getMouseCursorUri {}
• getOutsets {}
• getRight {}
• getScrollBarBaseColor {}
• getScrollBarProperties {}
• getToolTipText {}
• getTop {}
• getVerticalScroll {}
• getWidth {}
• getZIndex {}
• hashCode {}
• isHeightStretched {}
• isHidden {}
• isPositioned {}
• setAccessKey {String1}
• setAttribute {String1 Object2}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setBottom {Extent1}
• setHeight {Extent1}
• setHeightStretched {boolean1}
• setHidden {boolean1}
• setHorizontalScroll {Extent1}
• setInsets {Insets1}
• setLeft {Extent1}
• setMaximumStretchedHeight {Extent1}
• setMinimumStretchedHeight {Extent1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setRight {Extent1}
• setScrollBarBaseColor {Color1}
• setScrollBarProperties {ScrollBarProperties1}
• setToolTipText {String1}
• setTop {Extent1}
• setVerticalScroll {Extent1}
• setWidth {Extent1}
• setZIndex {int1}
• toString {}
• getPosition {}
• setPosition {position}
• getMouseCursor {}
• setMouseCursor {mousecursor}
• getScrollBarPolicy {}
• setScrollBarPolicy {policy}
  

Goto Top

---

ContentPaneEx

Inherits from Component

Properties

• -backgroundImage
• -horizontalScroll
• -insets
• -mouseCursor
• -mouseCursorUri
• -toolTipText
• -verticalScroll
  

Class Procedures

• _getObjType_ {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAttribute {String1}
• getAttributeNames {}
• getBackgroundImage {}
• getHorizontalScroll {}
• getInsets {}
• getMouseCursor {}
• getMouseCursorUri {}
• getToolTipText {}
• getVerticalScroll {}
• hashCode {}
• setAttribute {String1 Object2}
• setBackgroundImage {FillImage1}
• setHorizontalScroll {Extent1}
• setInsets {Insets1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setToolTipText {String1}
• setVerticalScroll {Extent1}
• toString {}
  

Goto Top

---

ContentPane

Inherits from Component

Properties

• -backgroundImage
• -horizontalScroll
• -insets
• -verticalScroll
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getBackgroundImage {}
• getHorizontalScroll {}
• getInsets {}
• getVerticalScroll {}
• hashCode {}
• setBackgroundImage {FillImage1}
• setHorizontalScroll {Extent1}
• setInsets {Insets1}
• setVerticalScroll {Extent1}
• toString {}
  

Goto Top

---

DerivedMutableStyle

Properties

• -parentStyle
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• addStyleContent {Style1}
• equals {Object1}
• getIndexedProperty {String1 int2}
• getParentStyle {}
• getProperty {String1}
• getPropertyIndices {String1}
• getPropertyNames {}
• hashCode {}
• isIndexedPropertySet {String1 int2}
• isPropertySet {String1}
• removeIndexedProperty {String1 int2}
• removeProperty {String1}
• setIndexedProperty {String1 int2 Object3}
• setParentStyle {Style1}
• setProperty {String1 Object2}
• size {}
• toString {}
  

Goto Top

---

DirectHtml

Inherits from Component

Properties

• -text
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getText {}
• hashCode {}
• setText {String1}
• toString {}
  

Goto Top

---

DisplayLayoutData

Properties

• -alignment
• -background
• -backgroundImage
• -border
• -bottom
• -clearFloat
• -float
• -font
• -foreground
• -height
• -inlineLayout
• -insets
• -left
• -mouseCursor
• -mouseCursorUri
• -outsets
• -position
• -right
• -toolTipText
• -top
• -width
• -zIndex
  

Class Procedures

• _getObjType_ {}
• STATIC {}
• ABSOLUTE {}
• RELATIVE {}
• FIXED {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
• FLOAT_NONE {}
• FLOAT_LEFT {}
• FLOAT_RIGHT {}
• FLOAT_CLEAR_NONE {}
• FLOAT_CLEAR_LEFT {}
• FLOAT_CLEAR_RIGHT {}
• FLOAT_CLEAR_BOTH {}
  

Methods

• _getObj_ {}
• _getType_ {}
• clear {}
• equals {Object1}
• getAlignment {}
• getBackground {}
• getBackgroundImage {}
• getBorder {}
• getBottom {}
• getFont {}
• getForeground {}
• getHeight {}
• getInsets {}
• getLeft {}
• getMouseCursorUri {}
• getOutsets {}
• getRenderProperty {args}
• getRight {}
• getToolTipText {}
• getTop {}
• getWidth {}
• getZIndex {}
• hashCode {}
• isInlineLayout {}
• isPositioned {}
• setAlignment {Alignment1}
• setBackground {Color1}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setBottom {Extent1}
• setFont {Font1}
• setForeground {Color1}
• setHeight {Extent1}
• setInlineLayout {boolean1}
• setInsets {Insets1}
• setLeft {Extent1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setRight {Extent1}
• setToolTipText {String1}
• setTop {Extent1}
• setWidth {Extent1}
• setZIndex {int1}
• toString {}
• getPosition {}
• setPosition {position}
• getMouseCursor {}
• setMouseCursor {mousecursor}
• getClearFloat {}
• setClearFloat {clearfloat}
• getFloat {}
• setFloat {float}
  

Goto Top

---

DragSource

Inherits from Component

Properties

• -command
  

Class Procedures

• _getObjType_ {}
• DROP_TARGET_LISTENERS_CHANGED_PROPERTY {}
• INPUT_DROP {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• fireDropEvent {DropEvent1}
• getDropTargetCount {}
• getToolTipText {String1}
• hashCode {}
• setToolTipText {String1}
• toString {}
• addDropTarget {widget}
• removeDropTarget {widget}
  

Goto Top

---

DropDownMenu

Inherits from Component

Properties

• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledExpandIcon
• -disabledForeground
• -expandIcon
• -height
• -menuBackground
• -menuBackgroundImage
• -menuBorder
• -menuForeground
• -selectionBackground
• -selectionBackgroundImage
• -selectionForeground
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• SELECTION_CHANGED_PROPERTY {}
• SELECTION_MODEL_CHANGED_PROPERTY {}
• INPUT_SELECT {}
• MODEL_CHANGED_PROPERTY {}
• STATE_MODEL_CHANGED_PROPERTY {}
• invokeItemCommand {dropDownMenuObj item}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• doAction {OptionModel1}
• equals {Object1}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledExpandIcon {}
• getDisabledForeground {}
• getExpandIcon {}
• getHeight {}
• getMenuBackground {}
• getMenuBackgroundImage {}
• getMenuBorder {}
• getMenuForeground {}
• getSelectionBackground {}
• getSelectionBackgroundImage {}
• getSelectionForeground {}
• getWidth {}
• hashCode {}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledExpandIcon {ImageReference1}
• setDisabledForeground {Color1}
• setExpandIcon {ImageReference1}
• setHeight {Extent1}
• setMenuBackground {Color1}
• setMenuBackgroundImage {FillImage1}
• setMenuBorder {Border1}
• setMenuForeground {Color1}
• setSelectionBackground {Color1}
• setSelectionBackgroundImage {FillImage1}
• setSelectionForeground {Color1}
• setWidth {Extent1}
• toString {}
• menu {menuObj}
• getMenu {}
• isEnabled {id}
• setEnabled {id enabledBoolean}
• isSelected {id}
• setSelected {id selectedBoolean}
• add {args}
• invoke {id}
  

Goto Top

---

ExpandableSection

Inherits from Component

Properties

• -accessKey
• -border
• -expanded
• -expansionGroup
• -expansionModel
• -height
• -hidden
• -insets
• -mouseCursor
• -mouseCursorUri
• -outsets
• -toolTipText
• -width
• -public
• -backgroundImage
• -expandedLeftIcon
• -expandedRightIcon
• -expandedTitle
• -expandedTitleBackgroundImage
• -leftIcon
• -rightIcon
• -rolloverBackground
• -rolloverBackgroundImage
• -rolloverBorder
• -rolloverFont
• -rolloverForeground
• -title
• -titleAlignment
• -titleBackgroundImage
• -titleBackground
• -titleForeground
• -expanded
• -rolloverEnabled
  

Class Procedures

• _getObjType_ {}
• DEFAULT_STYLE {}
• EXPANDED_CHANGED_PROPERTY {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAccessKey {}
• getAttribute {String1}
• getAttributeNames {}
• getBorder {}
• getExpansionGroup {}
• getExpansionModel {}
• getHeight {}
• getInsets {}
• getMouseCursor {}
• getMouseCursorUri {}
• getOutsets {}
• getToolTipText {}
• getWidth {}
• hashCode {}
• isExpanded {}
• isHidden {}
• setAccessKey {String1}
• setAttribute {String1 Object2}
• setBorder {Border1}
• setExpanded {boolean1}
• setExpansionGroup {ExpansionGroup1}
• setExpansionModel {ExpansionModel1}
• setHeight {Extent1}
• setHidden {boolean1}
• setInsets {Insets1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
• getBackgroundImage {}
• getExpandedLeftIcon {}
• getExpandedRightIcon {}
• getExpandedTitle {}
• getExpandedTitleBackgroundImage {}
• getLeftIcon {}
• getRightIcon {}
• getRolloverBackground {}
• getRolloverBackgroundImage {}
• getRolloverBorder {}
• getRolloverFont {}
• getRolloverForeground {}
• getTitle {}
• getTitleAlignment {}
• getTitleBackgroundImage {}
• isExpanded {}
• isRolloverEnabled {}
• setBackgroundImage {FillImage1}
• setExpanded {boolean1}
• setExpandedTitle {String1}
• setExpandedTitleBackgroundImage {FillImage1}
• setLeftExpandedIcon {ImageReference1}
• setLeftIcon {ImageReference1}
• setRightExpandedIcon {ImageReference1}
• setRightIcon {ImageReference1}
• setRolloverBackground {Color1}
• setRolloverBackgroundImage {FillImage1}
• setRolloverBorder {Border1}
• setRolloverEnabled {boolean1}
• setRolloverFont {Font1}
• setRolloverForeground {Color1}
• setTitle {String1}
• setTitleAlignment {Alignment1}
• setTitleBackgroundImage {FillImage1}
• setTitleBackground {Color1}
• setTitleForeground {Color1}
  

Goto Top

---

Extent

Constructor Arguments

integer
or
integer-unit

Where:

• integer is an integer, whose default units are pixels (PX)
• integer-unit is a integer with a unit suffix, one of: CM EM EX IN MM PC % PERCENT PT PX
  

Properties

Class Procedures

• _getObjType_ {}
• PX {}
• PERCENT {}
• PT {}
• CM {}
• MM {}
• IN {}
• EM {}
• EX {}
• PC {}
• add {Extent1 Extent2}
• validate {Extent1 int2}
• % {}
• _newObj_ {args}
  

Methods

• _getObj_ {}
• _getType_ {}
• compareTo {Object1}
• equals {Object1}
• getUnits {}
• getValue {}
• hashCode {}
• isComparableTo {Extent1}
• isEnglish {}
• isPercentage {}
• isPrint {}
• isSI {}
• toMm {}
• toPoint {}
• toString {}
  

Notes

Unit values may be specified in lower-case.

Goto Top

---

FillImageBorder

Constructor Arguments

color border-insets content-insets
or
color border-insets content-insets top-imgref topright-imgref right-imgref bottomright-imgref bottom-imgref bottomleft-imgref left-imgref topleft-imgref

Where:

• color is a valid Color constructor argument or object
• border-insets is a valid Insets constructor or object
• content-insets is a valid Insets constructor or object
• imgrefs are eight FillImage constructors or objects, from top clockwise to top-left
  

Properties

Class Procedures

• _getObjType_ {}
• TOP_LEFT {}
• TOP {}
• TOP_RIGHT {}
• LEFT {}
• RIGHT {}
• BOTTOM_LEFT {}
• BOTTOM {}
• BOTTOM_RIGHT {}
• _newObj_ {args}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getBorderInsets {}
• getColor {}
• getContentInsets {}
• getFillImage {int1}
• hashCode {}
• setBorderInsets {Insets1}
• setColor {Color1}
• setContentInsets {Insets1}
• setFillImage {int1 FillImage2}
• toString {}
  

Goto Top

---

FillImage

Constructor Arguments

img-ref
or
img-ref horizontalOffset verticalOffset repeat

Where:

• img-ref is a valid ImageReference constructor argument or object
• horizontalOffset is a valid Extents constructor or object
• verticalOffset is a valid Extents constructor or object
• repeat is one of: NO_REPEAT REPEAT REPEAT_HORIZONTAL REPEAT_VERTICAL
  

Properties

Class Procedures

• _getObjType_ {}
• NO_REPEAT {}
• REPEAT_HORIZONTAL {}
• REPEAT_VERTICAL {}
• REPEAT {}
• _newObj_ {args}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getHorizontalOffset {}
• getImage {}
• getRepeat {}
• getVerticalOffset {}
• hashCode {}
• toString {}
  

Goto Top

---

Font

Constructor Arguments

font style size

Where:

• font is one of: SANS_SERIF SERIF MONOSPACE HELVETICA ARIAL VERDANA TIMES TIMES_ROMAN TIMES_NEW_ROMAN COURIER COURIER_NEW
• style is one of: PLAIN BOLD ITALIC UNDERLINE OVERLINE LINE_THROUGH
• size is a valid Extent constructor argument or object
  

Properties

Class Procedures

• _getObjType_ {}
• SANS_SERIF {}
• SERIF {}
• MONOSPACE {}
• HELVETICA {}
• ARIAL {}
• VERDANA {}
• TIMES {}
• TIMES_ROMAN {}
• TIMES_NEW_ROMAN {}
• COURIER {}
• COURIER_NEW {}
• PLAIN {}
• BOLD {}
• ITALIC {}
• UNDERLINE {}
• OVERLINE {}
• LINE_THROUGH {}
• _newObj_ {args}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getSize {}
• getTypeface {}
• hashCode {}
• isBold {}
• isItalic {}
• isLineThrough {}
• isOverline {}
• isPlain {}
• isUnderline {}
• toString {}
  

Notes

Font name and syle may be specified in lower-case.

Goto Top

---

GridLayoutData

Properties

• -alignment
• -background
• -backgroundImage
• -columnSpan
• -insets
• -rowSpan
  

Class Procedures

• _getObjType_ {}
• SPAN_FILL {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getAlignment {}
• getBackground {}
• getBackgroundImage {}
• getColumnSpan {}
• getInsets {}
• getRowSpan {}
• hashCode {}
• setAlignment {Alignment1}
• setBackground {Color1}
• setBackgroundImage {FillImage1}
• setColumnSpan {int1}
• setInsets {Insets1}
• setRowSpan {int1}
• toString {}
  

Notes

This object is automatically created when using the Pack command, and is listed here for reference.

Goto Top

---

Grid

Inherits from Component

Properties

• -border
• -height
• -insets
• -orientation
• -size
• -width
  

Class Procedures

• _getObjType_ {}
• DEFAULT_SIZE {}
• ORIENTATION_HORIZONTAL {}
• ORIENTATION_VERTICAL {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getBorder {}
• getColumnWidth {int1}
• getHeight {}
• getInsets {}
• getOrientation {}
• getRowHeight {int1}
• getSize {}
• getWidth {}
• hashCode {}
• setBorder {Border1}
• setColumnWidth {int1 Extent2}
• setHeight {Extent1}
• setInsets {Insets1}
• setOrientation {int1}
• setRowHeight {int1 Extent2}
• setSize {int1}
• setWidth {Extent1}
• toString {}
  

Goto Top

---

GroupBox

Inherits from Component

Properties

• -accessKey
• -border
• -height
• -hidden
• -insets
• -mouseCursor
• -mouseCursorUri
• -outsets
• -title
• -titleLabel
• -toolTipText
• -width
  

Class Procedures

• _getObjType_ {}
• DEFAULT_STYLE {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAccessKey {}
• getAttribute {String1}
• getAttributeNames {}
• getBorder {}
• getHeight {}
• getInsets {}
• getMouseCursor {}
• getMouseCursorUri {}
• getOutsets {}
• getTitle {}
• getTitleLabel {}
• getToolTipText {}
• getWidth {}
• hashCode {}
• isHidden {}
• setAccessKey {String1}
• setAttribute {String1 Object2}
• setBorder {Border1}
• setHeight {Extent1}
• setHidden {boolean1}
• setInsets {Insets1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setTitle {String1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
• setTitleLabel {Label1}
  

Goto Top

---

HttpImageReference

Properties

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getHeight {}
• getRenderId {}
• getUri {}
• getWidth {}
• hashCode {}
• toString {}
  

Notes

Creating this object should be done through the ImageReference object;

Goto Top

---

ImageReference

Constructor Arguments

type-file ?width? ?height? ?content-type?

Where:

• type-file-obj is a type and file specfication or a java object.
1. awt-obj image is a java.awt.Image object reference
2. http://image/path image is URL image reference
3. resource:/image/path image is file residing in the distribution .war file or loadable from the CLASSPATH.
4. file:/image/path image is file residing on the local filesystem.
5. /image/path image is file residing on the local filesystem (same as file:).
• width optional, is a valid Extent constructor argument or object, or [java::null]
• height optional, is a valid Extent constructor argument or object, or [java::null]
• content-type optional, is a valid Mime type, eg. "image/png". If type-file is a file:, then the content-type will be assumed if the file suffix is one of: .jpg .jpeg .gif .png
  

Optional arguments are positional, e.g. if contentType is specified, it must be preceded by width and height.

Properties

Class Procedures

• _getObjType_ {}
• _newObj_ {args}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getHeight {}
• getRenderId {}
• getWidth {}
• hashCode {}
• toString {}
• getSource {}
  

Goto Top

---

Insets

Constructor Arguments

size
or
horizontalSize verticalSize
or
leftSize topSize rightSize bottomSize

Where:

• size is a valid Extent contructor or object, for all four margins.
• horizontalSize is a valid Extent contructor or object, for top margin.
• verticalSize is a valid Extent contructor or object, for botton margin.
• leftSize topSize rightSize bottomSize are valid Extent contructors or objects, for left, top, right, and bottom margins.
  

Properties

Class Procedures

• _getObjType_ {}
• _newObj_ {args}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getBottom {}
• getLeft {}
• getRight {}
• getTop {}
• hashCode {}
• toString {}
  

Goto Top

---

Label

Inherits from Component

Properties

• -icon
• -iconTextMargin
• -lineWrap
• -text
• -textAlignment
• -textPosition
• -toolTipText
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getIcon {}
• getIconTextMargin {}
• getText {}
• getTextAlignment {}
• getTextPosition {}
• getToolTipText {}
• hashCode {}
• isLineWrap {}
• setIcon {ImageReference1}
• setIconTextMargin {Extent1}
• setLineWrap {boolean1}
• setText {String1}
• setTextAlignment {Alignment1}
• setTextPosition {Alignment1}
• setToolTipText {String1}
• toString {}
  

Goto Top

---

LayoutData

Properties

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• hashCode {}
• toString {}
  

Notes

This object is automatically created when using the Pack command, and is listed here for reference.

Goto Top

---

LayoutDirection

Properties

Class Procedures

• _getObjType_ {}
• LTR {}
• RTL {}
• forLocale {Locale1}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• hashCode {}
• isLeftToRight {}
• toString {}
  

Goto Top

---

ListBox

Inherits from Component

Properties

• -border
• -cellRenderer
• -disabledBackground
• -disabledBorder
• -disabledFont
• -disabledForeground
• -height
• -insets
• -rolloverBackground
• -rolloverEnabled
• -rolloverFont
• -rolloverForeground
• -selectedIndices
• -selectionMode
• -toolTipText
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• INPUT_ACTION {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• LIST_DATA_CHANGED_PROPERTY {}
• LIST_MODEL_CHANGED_PROPERTY {}
• LIST_CELL_RENDERER_CHANGED_PROPERTY {}
• SELECTION_MODEL_CHANGED_PROPERTY {}
• SELECTION_CHANGED_PROPERTY {}
• DEFAULT_LIST_CELL_RENDERER {}
• SINGLE_SELECTION {}
• MULTIPLE_SELECTION {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getBorder {}
• getCellRenderer {}
• getDisabledBackground {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getHeight {}
• getInsets {}
• getMaxSelectedIndex {}
• getMinSelectedIndex {}
• getRolloverBackground {}
• getRolloverFont {}
• getRolloverForeground {}
• getSelectionMode {}
• getSelectionModel {}
• getToolTipText {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• isRolloverEnabled {}
• isSelectedIndex {int1}
• setBorder {Border1}
• setCellRenderer {ListCellRenderer1}
• setDisabledBackground {Color1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setHeight {Extent1}
• setInsets {Insets1}
• setRolloverBackground {Color1}
• setRolloverEnabled {boolean1}
• setRolloverFont {Font1}
• setRolloverForeground {Color1}
• setSelectedIndex {args}
• setSelectionMode {int1}
• setSelectionModel {ListSelectionModel1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
• insert {start args}
• get {start {end ""}}
• remove {start {end ""}}
• removeAll {}
• size {}
• getSelectedIndices {}
• getSelectedValue {}
• getSelectedValues {}
• setSelectedIndices {args}
  

Notes

The Listbox component creates a DefaultListModel, see Echo2 documentation for further reference.

Goto Top

---

MenuBarPane

Inherits from Component

Properties

• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledForeground
• -menuBackground
• -menuBackgroundImage
• -menuBorder
• -menuForeground
• -selectionBackground
• -selectionBackgroundImage
• -selectionForeground
• -command
  

Class Procedures

• _getObjType_ {}
• INPUT_SELECT {}
• MODEL_CHANGED_PROPERTY {}
• STATE_MODEL_CHANGED_PROPERTY {}
• invokeItemCommand {menuBarPaneObj item}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• doAction {OptionModel1}
• equals {Object1}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledForeground {}
• getMenuBackground {}
• getMenuBackgroundImage {}
• getMenuBorder {}
• getMenuForeground {}
• getSelectionBackground {}
• getSelectionBackgroundImage {}
• getSelectionForeground {}
• hashCode {}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledForeground {Color1}
• setMenuBackground {Color1}
• setMenuBackgroundImage {FillImage1}
• setMenuBorder {Border1}
• setMenuForeground {Color1}
• setSelectionBackground {Color1}
• setSelectionBackgroundImage {FillImage1}
• setSelectionForeground {Color1}
• toString {}
• menu {menuObj}
• getMenu {}
• isEnabled {id}
• setEnabled {id enabledBoolean}
• isSelected {id}
• setSelected {id selectedBoolean}
• add {args}
• invoke {id}
  

Goto Top

---

Menu

Properties

• -icon
• -text
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getIcon {}
• getId {}
• getItem {int1}
• getItemCount {}
• getText {}
• hashCode {}
• setIcon {ImageReference1}
• setText {String1}
• toString {}
• add {type args}
• getItemObj {id}
• _getItemObj_ {id}
• command {id args}
• setItemCommand {id cmd}
• getItemCommand {id}
• remove {id}
• _removeItem_ {id}
• findSubMenuForId {id}
• getSubMenuNames {}
• getArray {name}
  

Notes

Menu is is used to specify a menu for MenuBarPane or DropDownMenu. For Echo2 reference, see DefaultMenuModel.

Goto Top

---

MutableStyleSheet

Properties

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• addStyle {Class1 String2 Style3}
• addStyleSheet {MutableStyleSheet1}
• equals {Object1}
• getStyle {Class1 String2}
• hashCode {}
• toString {}
  

Goto Top

---

MutableStyle

Properties

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• addStyleContent {Style1}
• equals {Object1}
• getIndexedProperty {String1 int2}
• getProperty {String1}
• getPropertyIndices {String1}
• getPropertyNames {}
• hashCode {}
• isIndexedPropertySet {String1 int2}
• isPropertySet {String1}
• removeIndexedProperty {String1 int2}
• removeProperty {String1}
• setIndexedProperty {String1 int2 Object3}
• setProperty {String1 Object2}
• size {}
• toString {}
  

Goto Top

---

Panel

Inherits from Component

Properties

• -border
• -insets
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getBorder {}
• getInsets {}
• hashCode {}
• setBorder {Border1}
• setInsets {Insets1}
• toString {}
  

Goto Top

---

PasswordField

Inherits from Component

Properties

• -alignment
• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledBorder
• -disabledFont
• -disabledForeground
• -document
• -height
• -horizontalScroll
• -insets
• -maximumLength
• -text
• -toolTipText
• -verticalScroll
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• INPUT_ACTION {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• DOCUMENT_CHANGED_PROPERTY {}
• TEXT_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAlignment {}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getDocument {}
• getHeight {}
• getHorizontalScroll {}
• getInsets {}
• getMaximumLength {}
• getText {}
• getToolTipText {}
• getVerticalScroll {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• setAlignment {Alignment1}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setDocument {Document1}
• setHeight {Extent1}
• setHorizontalScroll {Extent1}
• setInsets {Insets1}
• setMaximumLength {int1}
• setText {String1}
• setToolTipText {String1}
• setVerticalScroll {Extent1}
• setWidth {Extent1}
• toString {}
• delete {start {end ""}}
• insert {idx str}
• get {}
  

Notes

Methods delete and insert can specify starting and ending positions with either an integer or the keyword end.

Goto Top

---

ProgressBar

Inherits from Component

Properties

• -accessKey
• -border
• -completedColor
• -height
• -hidden
• -insets
• -maximum
• -minimum
• -mouseCursor
• -mouseCursorUri
• -numberOfBlocks
• -orientation
• -outsets
• -progressString
• -progressStringPainted
• -toolTipText
• -uncompletedColor
• -value
• -width
  

Class Procedures

• _getObjType_ {}
• ORIENTATION_HORIZONTAL {}
• ORIENTATION_VERTICAL {}
• DEFAULT_STYLE {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAccessKey {}
• getAttribute {String1}
• getAttributeNames {}
• getBorder {}
• getCompletedColor {}
• getHeight {}
• getInsets {}
• getMaximum {}
• getMinimum {}
• getMouseCursor {}
• getMouseCursorUri {}
• getNumberOfBlocks {}
• getOrientation {}
• getOutsets {}
• getPercentComplete {}
• getProgressBarImage {}
• getProgressString {}
• getToolTipText {}
• getUncompletedColor {}
• getValue {}
• getWidth {}
• hashCode {}
• invalidate {}
• isHidden {}
• isProgressStringPainted {}
• setAccessKey {String1}
• setAttribute {String1 Object2}
• setBorder {Border1}
• setCompletedColor {Color1}
• setHeight {Extent1}
• setHidden {boolean1}
• setInsets {Insets1}
• setMaximum {int1}
• setMinimum {int1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setNumberOfBlocks {int1}
• setOrientation {args}
• setOutsets {Insets1}
• setProgressString {String1}
• setProgressStringPainted {boolean1}
• setToolTipText {String1}
• setUncompletedColor {Color1}
• setValue {int1}
• setWidth {Extent1}
• toString {}
  

Goto Top

---

RadioButton

Inherits from Component

Properties

• -alignment
• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledBorder
• -disabledFont
• -disabledForeground
• -disabledIcon
• -group
• -height
• -icon
• -iconTextMargin
• -insets
• -lineWrap
• -pressedBackground
• -pressedBackgroundImage
• -pressedBorder
• -pressedEnabled
• -pressedFont
• -pressedForeground
• -pressedIcon
• -pressedSelectedStateIcon
• -pressedStateIcon
• -rolloverBackground
• -rolloverBackgroundImage
• -rolloverBorder
• -rolloverEnabled
• -rolloverFont
• -rolloverForeground
• -rolloverIcon
• -rolloverSelectedStateIcon
• -rolloverStateIcon
• -selected
• -selectedStateIcon
• -stateAlignment
• -stateIcon
• -stateMargin
• -statePosition
• -text
• -textAlignment
• -textPosition
• -toolTipText
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• BUTTON_GROUP_CHANGED_PROPERTY {}
• SELECTED_CHANGED_PROPERTY {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• INPUT_CLICK {}
• newButtonGroup {Group}
  

Methods

• _getObj_ {}
• _getType_ {}
• addChangeListener {ChangeListener1}
• dispose {}
• doAction {}
• equals {Object1}
• fireActionPerformed {ActionEvent1}
• fireStateChanged {}
• getAlignment {}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getDisabledIcon {}
• getHeight {}
• getIcon {}
• getIconTextMargin {}
• getInsets {}
• getPressedBackground {}
• getPressedBackgroundImage {}
• getPressedBorder {}
• getPressedFont {}
• getPressedForeground {}
• getPressedIcon {}
• getPressedSelectedStateIcon {}
• getPressedStateIcon {}
• getRolloverBackground {}
• getRolloverBackgroundImage {}
• getRolloverBorder {}
• getRolloverFont {}
• getRolloverForeground {}
• getRolloverIcon {}
• getRolloverSelectedStateIcon {}
• getRolloverStateIcon {}
• getSelectedStateIcon {}
• getStateAlignment {}
• getStateIcon {}
• getStateMargin {}
• getStatePosition {}
• getText {}
• getTextAlignment {}
• getTextPosition {}
• getToolTipText {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• isLineWrap {}
• isPressedEnabled {}
• isRolloverEnabled {}
• isSelected {}
• removeChangeListener {ChangeListener1}
• setAlignment {Alignment1}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setDisabledIcon {ImageReference1}
• setHeight {Extent1}
• setIcon {ImageReference1}
• setIconTextMargin {Extent1}
• setInsets {Insets1}
• setLineWrap {boolean1}
• setPressedBackground {Color1}
• setPressedBackgroundImage {FillImage1}
• setPressedBorder {Border1}
• setPressedEnabled {boolean1}
• setPressedFont {Font1}
• setPressedForeground {Color1}
• setPressedIcon {ImageReference1}
• setPressedSelectedStateIcon {ImageReference1}
• setPressedStateIcon {ImageReference1}
• setRolloverBackground {Color1}
• setRolloverBackgroundImage {FillImage1}
• setRolloverBorder {Border1}
• setRolloverEnabled {boolean1}
• setRolloverFont {Font1}
• setRolloverForeground {Color1}
• setRolloverIcon {ImageReference1}
• setRolloverSelectedStateIcon {ImageReference1}
• setRolloverStateIcon {ImageReference1}
• setSelected {boolean1}
• setSelectedStateIcon {ImageReference1}
• setStateAlignment {Alignment1}
• setStateIcon {ImageReference1}
• setStateMargin {Extent1}
• setStatePosition {Alignment1}
• setText {String1}
• setTextAlignment {Alignment1}
• setTextPosition {Alignment1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
• setGroup {Group}
• getGroup {}
  

Goto Top

---

ResourceImageReference

Properties

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getContentType {}
• getHeight {}
• getRenderId {}
• getResource {}
• getWidth {}
• hashCode {}
• render {OutputStream1}
• toString {}
  

Notes

Creating this object should be done through the ImageReference object;

Goto Top

---

RichTextArea

Inherits from Component

Properties

• -alignment
• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledBorder
• -disabledFont
• -disabledForeground
• -document
• -editable
• -editorBackground
• -editorBorder
• -editorFont
• -editorForeground
• -height
• -horizontalScroll
• -insets
• -maximumLength
• -mouseCursor
• -mouseCursorUri
• -outsets
• -renderer
• -spellCheckInProgress
• -spellChecker
• -text
• -toolBarAlignment
• -toolBarBackground
• -toolTipText
• -verticalScroll
• -width
• -command
• -editToolBar
  

Class Procedures

• _getObjType_ {}
• DEFAULT_STYLE {}
• DEFAULT_TOOLBAR_BACKGROUND {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• INPUT_ACTION {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• DOCUMENT_CHANGED_PROPERTY {}
• TEXT_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAlignment {}
• getAttribute {String1}
• getAttributeNames {}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getDocument {}
• getEditorBackground {}
• getEditorBorder {}
• getEditorFont {}
• getEditorForeground {}
• getHeight {}
• getHorizontalScroll {}
• getInsets {}
• getMaximumLength {}
• getMouseCursor {}
• getMouseCursorUri {}
• getOutsets {}
• getText {}
• getToolBarAlignment {}
• getToolBarBackground {}
• getToolTipText {}
• getVerticalScroll {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• isEditable {}
• isSpellCheckInProgress {}
• setAlignment {Alignment1}
• setAttribute {String1 Object2}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setDocument {Document1}
• setEditable {boolean1}
• setEditorBackground {Color1}
• setEditorBorder {Border1}
• setEditorFont {Font1}
• setEditorForeground {Color1}
• setHeight {Extent1}
• setHorizontalScroll {Extent1}
• setInsets {Insets1}
• setMaximumLength {int1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setText {String1}
• setToolBarAlignment {int1}
• setToolBarBackground {Color1}
• setToolTipText {String1}
• setVerticalScroll {Extent1}
• setWidth {Extent1}
• toString {}
• getEditToolBar {}
• setEditToolBar {state}
• getPlainText {}
• setPlainText {txt {tagStart ""}
• search {args}
  

Notes

Methods search and setPlainText can specify starting and ending positions with a linenumber.charposition index notation. Acceptable values are:

• n - a linenumber (starting at 1). Linenumber can be 0, which specifies the beginning of the first line, as does 1.0.
  
• n.m - a linenumber (starting at 1) and a character position (starting at 0)
  
• n.end - a linenumber (starting at 1), and the ending character position of the line
  
• end - the ending character position of the last line
  

getPlainText

Retrieves the rich text document, and strips all HTML tags. Linebreaks are specified with newline characters.

setPlainText text ?startHtmlTag? ?endHtmlTag? ?indexList?

Sets the text, with optional HTML tags around specified documents indices. If specified ?startHtmlTag? and ?endHTmlTag? are inserted around start and end index pairs specified in ?indexList?. Multiple indices can be specified in indexList. indexList can also be specified as a list of individual values instead of a list.

search ?-nocase? ?-regexp? searchText ?startIndex? ?endIndex?

Returns the starting position (n.m) of the searchText of the text returned by 'getPlainText, or null if not found. If ?startIndex? is not specified, search the entire document, if ?endIndex? is not specified, search from the start position to the end of the document. Switches -nocase and -regexp cause the search to be case insensitive or specifies the searchText as a regular expression. Both -nocase and -regexp can be specified.

Goto Top

---

RowLayoutData

Properties

• -alignment
• -background
• -backgroundImage
• -insets
• -width
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getAlignment {}
• getBackground {}
• getBackgroundImage {}
• getInsets {}
• getWidth {}
• hashCode {}
• setAlignment {Alignment1}
• setBackground {Color1}
• setBackgroundImage {FillImage1}
• setInsets {Insets1}
• setWidth {Extent1}
• toString {}
  

Notes

This object is automatically created when using the Pack command, and is listed here for reference.

Goto Top

---

Row

Inherits from Component

Properties

• -alignment
• -border
• -cellSpacing
• -insets
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAlignment {}
• getBorder {}
• getCellSpacing {}
• getInsets {}
• hashCode {}
• setAlignment {Alignment1}
• setBorder {Border1}
• setCellSpacing {Extent1}
• setInsets {Insets1}
• toString {}
  

Goto Top

---

ScrollableDisplayLayoutData

Properties

• -alignment
• -background
• -backgroundImage
• -border
• -bottom
• -clearFloat
• -float
• -font
• -foreground
• -height
• -inlineLayout
• -insets
• -left
• -mouseCursor
• -mouseCursorUri
• -outsets
• -position
• -right
• -scrollBarBaseColor
• -scrollBarPolicy
• -scrollBarProperties
• -toolTipText
• -top
• -width
• -zIndex
  

Class Procedures

• _getObjType_ {}
• UNDEFINED {}
• NEVER {}
• ALWAYS {}
• AUTO {}
• CLIPHIDE {}
• STATIC {}
• ABSOLUTE {}
• RELATIVE {}
• FIXED {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
• FLOAT_NONE {}
• FLOAT_LEFT {}
• FLOAT_RIGHT {}
• FLOAT_CLEAR_NONE {}
• FLOAT_CLEAR_LEFT {}
• FLOAT_CLEAR_RIGHT {}
• FLOAT_CLEAR_BOTH {}
  

Methods

• _getObj_ {}
• _getType_ {}
• clear {}
• equals {Object1}
• getAlignment {}
• getBackground {}
• getBackgroundImage {}
• getBorder {}
• getBottom {}
• getFont {}
• getForeground {}
• getHeight {}
• getInsets {}
• getLeft {}
• getMouseCursorUri {}
• getOutsets {}
• getRenderProperty {args}
• getRight {}
• getScrollBarBaseColor {}
• getScrollBarProperties {}
• getToolTipText {}
• getTop {}
• getWidth {}
• getZIndex {}
• hashCode {}
• isInlineLayout {}
• isPositioned {}
• setAlignment {Alignment1}
• setBackground {Color1}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setBottom {Extent1}
• setFont {Font1}
• setForeground {Color1}
• setHeight {Extent1}
• setInlineLayout {boolean1}
• setInsets {Insets1}
• setLeft {Extent1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setRight {Extent1}
• setScrollBarBaseColor {Color1}
• setScrollBarProperties {ScrollBarProperties1}
• setToolTipText {String1}
• setTop {Extent1}
• setWidth {Extent1}
• setZIndex {int1}
• toString {}
• getScrollBarPolicy {}
• setScrollBarPolicy {policy}
• getPosition {}
• setPosition {position}
• getMouseCursor {}
• setMouseCursor {mousecursor}
• getClearFloat {}
• setClearFloat {clearfloat}
• getFloat {}
• setFloat {float}
  

Goto Top

---

SelectField

Inherits from Component

Properties

• -border
• -cellRenderer
• -disabledBackground
• -disabledBorder
• -disabledFont
• -disabledForeground
• -height
• -insets
• -rolloverBackground
• -rolloverEnabled
• -rolloverFont
• -rolloverForeground
• -selectedIndex
• -selectedItem
• -toolTipText
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• INPUT_ACTION {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• LIST_DATA_CHANGED_PROPERTY {}
• LIST_MODEL_CHANGED_PROPERTY {}
• LIST_CELL_RENDERER_CHANGED_PROPERTY {}
• SELECTION_MODEL_CHANGED_PROPERTY {}
• SELECTION_CHANGED_PROPERTY {}
• DEFAULT_LIST_CELL_RENDERER {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getBorder {}
• getCellRenderer {}
• getDisabledBackground {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getHeight {}
• getInsets {}
• getRolloverBackground {}
• getRolloverFont {}
• getRolloverForeground {}
• getSelectedIndex {}
• getSelectionModel {}
• getToolTipText {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• isRolloverEnabled {}
• setBorder {Border1}
• setCellRenderer {ListCellRenderer1}
• setDisabledBackground {Color1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setHeight {Extent1}
• setInsets {Insets1}
• setRolloverBackground {Color1}
• setRolloverEnabled {boolean1}
• setRolloverFont {Font1}
• setRolloverForeground {Color1}
• setSelectedIndex {int1}
• setSelectedItem {Object1}
• setSelectionModel {ListSelectionModel1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
• insert {start args}
• get {start {end ""}}
• remove {start {end ""}}
• removeAll {}
• size {}
• getSelectedItem {}
  

Notes

Methods insert, get, and remove can specify starting and ending positions with either an integer or the keyword end.

Goto Top

---

Slider

Inherits from Component

Properties

• -accessKey
• -border
• -height
• -hidden
• -immediateNotification
• -insets
• -maximum
• -minimum
• -mouseCursor
• -mouseCursorUri
• -orientation
• -outsets
• -toolTipText
• -value
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• DEFAULT_HORIZONTAL_STYLE {}
• DEFAULT_VERTICAL_STYLE {}
• DEFAULT_STYLE {}
• ORIENTATION_HORIZONTAL {}
• ORIENTATION_VERTICAL {}
• VALUE_CHANGED_PROPERTY {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAccessKey {}
• getAttribute {String1}
• getAttributeNames {}
• getBorder {}
• getHeight {}
• getInsets {}
• getMaximum {}
• getMinimum {}
• getMouseCursor {}
• getMouseCursorUri {}
• getOrientation {}
• getOutsets {}
• getToolTipText {}
• getValue {}
• getWidth {}
• hashCode {}
• isHidden {}
• isImmediateNotification {}
• setAccessKey {String1}
• setAttribute {String1 Object2}
• setBorder {Border1}
• setHeight {Extent1}
• setHidden {boolean1}
• setImmediateNotification {boolean1}
• setInsets {Insets1}
• setMaximum {int1}
• setMinimum {int1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setOrientation {int1}
• setOutsets {Insets1}
• setToolTipText {String1}
• setValue {int1}
• setWidth {Extent1}
• toString {}
  

Goto Top

---

SplitPaneLayoutData

Properties

• -alignment
• -background
• -backgroundImage
• -insets
• -maximumSize
• -minimumSize
• -overflow
  

Class Procedures

• _getObjType_ {}
• OVERFLOW_AUTO {}
• OVERFLOW_HIDDEN {}
• OVERFLOW_SCROLL {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getAlignment {}
• getBackground {}
• getBackgroundImage {}
• getInsets {}
• getMaximumSize {}
• getMinimumSize {}
• hashCode {}
• setAlignment {Alignment1}
• setBackground {Color1}
• setBackgroundImage {FillImage1}
• setInsets {Insets1}
• setMaximumSize {Extent1}
• setMinimumSize {Extent1}
• toString {}
• getOverflow {}
• setOverflow {overflow}
  

Notes

This object is automatically created when using the Pack command, and is listed here for reference.

Goto Top

---

SplitPane

Inherits from Component

Properties

• -orientation
• -resizable
• -separatorColor
• -separatorHeight
• -separatorHorizontalImage
• -separatorPosition
• -separatorVerticalImage
• -separatorWidth
  

Class Procedures

• _getObjType_ {}
• ORIENTATION_HORIZONTAL_LEADING_TRAILING {}
• ORIENTATION_HORIZONTAL_TRAILING_LEADING {}
• ORIENTATION_HORIZONTAL_LEFT_RIGHT {}
• ORIENTATION_HORIZONTAL_RIGHT_LEFT {}
• ORIENTATION_VERTICAL_TOP_BOTTOM {}
• ORIENTATION_VERTICAL_BOTTOM_TOP {}
• ORIENTATION_HORIZONTAL {}
• ORIENTATION_VERTICAL {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getOrientation {}
• getSeparatorColor {}
• getSeparatorHeight {}
• getSeparatorHorizontalImage {}
• getSeparatorPosition {}
• getSeparatorVerticalImage {}
• getSeparatorWidth {}
• hashCode {}
• isResizable {}
• setOrientation {int1}
• setResizable {boolean1}
• setSeparatorColor {Color1}
• setSeparatorHeight {Extent1}
• setSeparatorHorizontalImage {FillImage1}
• setSeparatorPosition {Extent1}
• setSeparatorVerticalImage {FillImage1}
• setSeparatorWidth {Extent1}
• toString {}
  

Goto Top

---

StreamImageReference

Properties

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getContentType {}
• getHeight {}
• getRenderId {}
• getWidth {}
• hashCode {}
• render {OutputStream1}
• toString {}
  

Notes

Creating this object should be done through the ImageReference object;

Goto Top

---

Strut

Inherits from Component

Properties

• -accessKey
• -border
• -height
• -hidden
• -insets
• -mouseCursor
• -mouseCursorUri
• -outsets
• -toolTipText
• -width
  

Class Procedures

• _getObjType_ {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAccessKey {}
• getAttribute {String1}
• getAttributeNames {}
• getBorder {}
• getHeight {}
• getInsets {}
• getMouseCursor {}
• getMouseCursorUri {}
• getOutsets {}
• getToolTipText {}
• getWidth {}
• hashCode {}
• isHidden {}
• setAccessKey {String1}
• setAttribute {String1 Object2}
• setBorder {Border1}
• setHeight {Extent1}
• setHidden {boolean1}
• setInsets {Insets1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setToolTipText {String1}
• setWidth {Extent1}
• toString {}
  

Goto Top

---

TableLayoutData

Properties

• -alignment
• -background
• -backgroundImage
• -insets
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getAlignment {}
• getBackground {}
• getBackgroundImage {}
• getInsets {}
• hashCode {}
• setAlignment {Alignment1}
• setBackground {Color1}
• setBackgroundImage {FillImage1}
• setInsets {Insets1}
• toString {}
  

Notes

This object is automatically created when using the Pack command, and is listed here for reference.

Goto Top

---

Table

Inherits from Component

Properties

• -autoCreateColumnsFromModel
• -border
• -defaultHeaderRenderer
• -headerVisible
• -insets
• -rolloverBackground
• -rolloverBackgroundImage
• -rolloverEnabled
• -rolloverFont
• -rolloverForeground
• -selectionBackground
• -selectionBackgroundImage
• -selectionEnabled
• -selectionFont
• -selectionForeground
• -width
• -command
• -rows
• -columns
• -cellRenderer
• -headerRenderer
  

Class Procedures

• _getObjType_ {}
• DEFAULT_TABLE_CELL_RENDERER {}
• INPUT_ACTION {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• AUTO_CREATE_COLUMNS_FROM_MODEL_CHANGED_PROPERTY {}
• COLUMN_MODEL_CHANGED_PROPERTY {}
• DEFAULT_HEADER_RENDERER_CHANGED_PROPERTY {}
• DEFAULT_RENDERER_CHANGED_PROPERTY {}
• HEADER_VISIBLE_CHANGED_PROPERTY {}
• MODEL_CHANGED_PROPERTY {}
• SELECTION_CHANGED_PROPERTY {}
• SELECTION_MODEL_CHANGED_PROPERTY {}
• HEADER_ROW {}
• SINGLE_SELECTION {}
• MULTIPLE_SELECTION {}
  

Methods

• _getObj_ {}
• _getType_ {}
• createDefaultColumnsFromModel {}
• dispose {}
• equals {Object1}
• getBorder {}
• getCellComponent {int1 int2}
• getDefaultHeaderRenderer {}
• getDefaultRenderer {Class1}
• getInsets {}
• getRolloverBackground {}
• getRolloverBackgroundImage {}
• getRolloverFont {}
• getRolloverForeground {}
• getSelectionBackground {}
• getSelectionBackgroundImage {}
• getSelectionFont {}
• getSelectionForeground {}
• getSelectionModel {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• isAutoCreateColumnsFromModel {}
• isHeaderVisible {}
• isRolloverEnabled {}
• isSelectionEnabled {}
• setAutoCreateColumnsFromModel {boolean1}
• setBorder {Border1}
• setDefaultHeaderRenderer {TableCellRenderer1}
• setDefaultRenderer {Class1 TableCellRenderer2}
• setHeaderVisible {boolean1}
• setInsets {Insets1}
• setRolloverBackground {Color1}
• setRolloverBackgroundImage {FillImage1}
• setRolloverEnabled {boolean1}
• setRolloverFont {Font1}
• setRolloverForeground {Color1}
• setSelectionBackground {Color1}
• setSelectionBackgroundImage {FillImage1}
• setSelectionEnabled {boolean1}
• setSelectionFont {Font1}
• setSelectionForeground {Color1}
• setSelectionModel {ListSelectionModel1}
• setWidth {Extent1}
• toString {}
• insertRow {row columnList}
• deleteRow {row}
• deleteAll {}
• setColumnName {col name}
• getColumnName {col}
• setValueAt {value col row}
• getValueAt {col row}
• setColumnHeaderValue {col value}
• getColumnHeaderValue {col}
• setColumnWidth {col Extent1}
• getColumnWidth {col}
• clearSelection {}
• setSelectionMode {mode}
• getSelectionMode {}
• setSelectedIndex {row bool}
• getMaxSelectedIndex {}
• getMinSelectedIndex {}
• isSelectedIndex {row}
• getSelectedIndices {}
• setCellLabelAttrs {columnIdx rowNum args}
  

Notes

The Table component creates a default DefaultTableModel, DefaultTableColumnModel, and DefaultListSelectionMode. See Echo2 documentation for further reference.

Goto Top

---

TabPaneLayoutData

Properties

• -title
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• equals {Object1}
• getTitle {}
• hashCode {}
• setTitle {String1}
• toString {}
  

Notes

This object is automatically created when using the Pack command, and is listed here for reference.

Goto Top

---

TabPane

Inherits from Component

Properties

• -activeTabIndex
• -borderType
• -defaultContentInsets
• -insets
• -tabActiveBackground
• -tabActiveBackgroundImage
• -tabActiveBorder
• -tabActiveFont
• -tabActiveForeground
• -tabHeight
• -tabInactiveBackground
• -tabInactiveBackgroundImage
• -tabInactiveBorder
• -tabInactiveFont
• -tabInactiveForeground
• -tabInset
• -tabPosition
• -tabSpacing
• -tabWidth
  

Class Procedures

• _getObjType_ {}
• INPUT_TAB_INDEX {}
• ACTIVE_TAB_INDEX_CHANGED_PROPERTY {}
• BORDER_TYPE_NONE {}
• BORDER_TYPE_ADJACENT_TO_TABS {}
• BORDER_TYPE_PARALLEL_TO_TABS {}
• BORDER_TYPE_SURROUND {}
• TAB_POSITION_BOTTOM {}
• TAB_POSITION_TOP {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getActiveTabIndex {}
• getBorderType {}
• getDefaultContentInsets {}
• getInsets {}
• getTabActiveBackground {}
• getTabActiveBackgroundImage {}
• getTabActiveBorder {}
• getTabActiveFont {}
• getTabActiveForeground {}
• getTabHeight {}
• getTabInactiveBackground {}
• getTabInactiveBackgroundImage {}
• getTabInactiveBorder {}
• getTabInactiveFont {}
• getTabInactiveForeground {}
• getTabInset {}
• getTabPosition {}
• getTabSpacing {}
• getTabWidth {}
• hashCode {}
• setActiveTabIndex {int1}
• setBorderType {int1}
• setDefaultContentInsets {Insets1}
• setInsets {Insets1}
• setTabActiveBackground {Color1}
• setTabActiveBackgroundImage {FillImage1}
• setTabActiveBorder {Border1}
• setTabActiveFont {Font1}
• setTabActiveForeground {Color1}
• setTabHeight {Extent1}
• setTabInactiveBackground {Color1}
• setTabInactiveBackgroundImage {FillImage1}
• setTabInactiveBorder {Border1}
• setTabInactiveFont {Font1}
• setTabInactiveForeground {Color1}
• setTabInset {Extent1}
• setTabPosition {int1}
• setTabSpacing {Extent1}
• setTabWidth {Extent1}
• toString {}
  

Goto Top

---

TextArea

Inherits from Component

Properties

• -alignment
• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledBorder
• -disabledFont
• -disabledForeground
• -document
• -height
• -horizontalScroll
• -insets
• -maximumLength
• -text
• -toolTipText
• -verticalScroll
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• INPUT_ACTION {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• DOCUMENT_CHANGED_PROPERTY {}
• TEXT_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAlignment {}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getDocument {}
• getHeight {}
• getHorizontalScroll {}
• getInsets {}
• getMaximumLength {}
• getText {}
• getToolTipText {}
• getVerticalScroll {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• setAlignment {Alignment1}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setDocument {Document1}
• setHeight {Extent1}
• setHorizontalScroll {Extent1}
• setInsets {Insets1}
• setMaximumLength {int1}
• setText {String1}
• setToolTipText {String1}
• setVerticalScroll {Extent1}
• setWidth {Extent1}
• toString {}
• search {args}
• insert {idx str}
  

Notes

Methods search and insert can specify starting and ending positions with a linenumber.charposition index notation. Acceptable values are:

• n - a linenumber (starting at 1). Linenumber can be 0, which specifies the beginning of the first line, as does 1.0.
  
• n.m - a linenumber (starting at 1) and a character position (starting at 0)
  
• n.end - a linenumber (starting at 1), and the ending character position of the line
  
• end - the ending character position of the last line
  

search ?-nocase? ?-regexp? searchText ?startIndex? ?endIndex?

Returns the starting position (n.m) of the searchText, or null if not found. If ?startIndex? is not specified, search the entire document, if ?endIndex? is not specified, search from the start position to the end of the document. Switches -nocase and -regexp cause the search to be case insensitive or specifies the searchText as a regular expression. Both -nocase and -regexp can be specified.

insert startIndex text

Inserts the text at the startIndex position.

Goto Top

---

TextFieldEx

Inherits from Component

Properties

• -accessKey
• -actionCausedOnChange
• -alignment
• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledBorder
• -disabledFont
• -disabledForeground
• -document
• -height
• -hiddenField
• -horizontalScroll
• -insets
• -maximumLength
• -mouseCursor
• -mouseCursorUri
• -outsets
• -regex
• -regexFailureProperties
• -text
• -toolTipText
• -verticalScroll
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• CURSOR_AUTO {}
• CURSOR_DEFAULT {}
• CURSOR_CROSSHAIR {}
• CURSOR_POINTER {}
• CURSOR_MOVE {}
• CURSOR_E_RESIZE {}
• CURSOR_NE_RESIZE {}
• CURSOR_NW_RESIZE {}
• CURSOR_N_RESIZE {}
• CURSOR_SE_RESIZE {}
• CURSOR_SW_RESIZE {}
• CURSOR_S_RESIZE {}
• CURSOR_W_RESIZE {}
• CURSOR_TEXT {}
• CURSOR_WAIT {}
• CURSOR_HELP {}
• CURSOR_CUSTOM_URI {}
• DEFAULT_INSETS {}
• DEFAULT_OUTSETS {}
• INPUT_ACTION {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• DOCUMENT_CHANGED_PROPERTY {}
• TEXT_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAccessKey {}
• getActionCausedOnChange {}
• getAlignment {}
• getAttribute {String1}
• getAttributeNames {}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getDocument {}
• getHeight {}
• getHorizontalScroll {}
• getInsets {}
• getMaximumLength {}
• getMouseCursor {}
• getMouseCursorUri {}
• getOutsets {}
• getRegex {}
• getRegexFailureProperties {}
• getText {}
• getToolTipText {}
• getVerticalScroll {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• isHiddenField {}
• setAccessKey {String1}
• setActionCausedOnChange {boolean1}
• setAlignment {Alignment1}
• setAttribute {String1 Object2}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setDocument {Document1}
• setHeight {Extent1}
• setHiddenField {boolean1}
• setHorizontalScroll {Extent1}
• setInsets {Insets1}
• setMaximumLength {int1}
• setMouseCursor {int1}
• setMouseCursorUri {String1}
• setOutsets {Insets1}
• setRegex {String1}
• setRegexFailureProperties {AbleProperties1}
• setText {String1}
• setToolTipText {String1}
• setVerticalScroll {Extent1}
• setWidth {Extent1}
• toString {}
• delete {start {end ""}}
• insert {idx str}
• get {}
  

Notes

Methods delete and insert can specify starting and ending positions with either an integer or the keyword end.

Property -regex (method setRegex) must be a valid regular expression in the Javascript language.

Property regexFailureProperties (method setRegexFailureProperties) must be an instance of AbleProperties and those properties are set when the entered text does not match the regular expression.

Goto Top

---

TextField

Inherits from Component

Properties

• -alignment
• -backgroundImage
• -border
• -disabledBackground
• -disabledBackgroundImage
• -disabledBorder
• -disabledFont
• -disabledForeground
• -document
• -height
• -horizontalScroll
• -insets
• -maximumLength
• -text
• -toolTipText
• -verticalScroll
• -width
• -command
  

Class Procedures

• _getObjType_ {}
• INPUT_ACTION {}
• ACTION_LISTENERS_CHANGED_PROPERTY {}
• DOCUMENT_CHANGED_PROPERTY {}
• TEXT_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getAlignment {}
• getBackgroundImage {}
• getBorder {}
• getDisabledBackground {}
• getDisabledBackgroundImage {}
• getDisabledBorder {}
• getDisabledFont {}
• getDisabledForeground {}
• getDocument {}
• getHeight {}
• getHorizontalScroll {}
• getInsets {}
• getMaximumLength {}
• getText {}
• getToolTipText {}
• getVerticalScroll {}
• getWidth {}
• hasActionListeners {}
• hashCode {}
• setAlignment {Alignment1}
• setBackgroundImage {FillImage1}
• setBorder {Border1}
• setDisabledBackground {Color1}
• setDisabledBackgroundImage {FillImage1}
• setDisabledBorder {Border1}
• setDisabledFont {Font1}
• setDisabledForeground {Color1}
• setDocument {Document1}
• setHeight {Extent1}
• setHorizontalScroll {Extent1}
• setInsets {Insets1}
• setMaximumLength {int1}
• setText {String1}
• setToolTipText {String1}
• setVerticalScroll {Extent1}
• setWidth {Extent1}
• toString {}
• delete {start {end ""}}
• insert {idx str}
• get {}
  

Notes

Methods delete and insert can specify starting and ending positions with either an integer or the keyword end.

Goto Top

---

TransitionPane

Inherits from Component

Properties

• -duration
• -type
  

Class Procedures

• _getObjType_ {}
• TYPE_IMMEDIATE_REPLACE {}
• TYPE_CAMERA_PAN_LEFT {}
• TYPE_CAMERA_PAN_RIGHT {}
• TYPE_CAMERA_PAN_UP {}
• TYPE_CAMERA_PAN_DOWN {}
• TYPE_BLIND_BLACK_IN {}
• TYPE_BLIND_BLACK_OUT {}
• TYPE_FADE_TO_BLACK {}
• TYPE_FADE_TO_WHITE {}
• TYPE_FADE {}
• DEFAULT_DURATION {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getDuration {}
• getType {}
• hashCode {}
• setDuration {int1}
• setType {int1}
• toString {}
  

Goto Top

---

UploadSelect

Inherits from Component

Properties

• -disabledSendButtonText
• -enabledSendButtonText
• -height
• -sendButtonDisplayed
• -uploadListener
• -width
• -keepTempFile
• -command
  

Class Procedures

• _getObjType_ {}
• UPLOAD_LISTENER_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• fileUpload {InputStream1 int2 String3 String4}
• getDisabledSendButtonText {}
• getEnabledSendButtonText {}
• getHeight {}
• getWidth {}
• hashCode {}
• isSendButtonDisplayed {}
• removeUploadListener {UploadListener1}
• setDisabledSendButtonText {String1}
• setEnabledSendButtonText {String1}
• setHeight {Extent1}
• setSendButtonDisplayed {boolean1}
• setWidth {Extent1}
• toString {}
  

Goto Top

---

WindowPane

Inherits from Component

Properties

• -backgroundImage
• -border
• -closable
• -closeIcon
• -closeIconInsets
• -defaultCloseOperation
• -height
• -icon
• -iconInsets
• -insets
• -maximumHeight
• -maximumWidth
• -minimumHeight
• -minimumWidth
• -modal
• -movable
• -positionX
• -positionY
• -resizable
• -title
• -titleBackground
• -titleBackgroundImage
• -titleBarInsets
• -titleFont
• -titleForeground
• -titleHeight
• -titleInsets
• -width
• -zIndex
• -onclose
  

Class Procedures

• _getObjType_ {}
• INPUT_CLOSE {}
• Z_INDEX_CHANGED_PROPERTY {}
• DO_NOTHING_ON_CLOSE {}
• HIDE_ON_CLOSE {}
• DISPOSE_ON_CLOSE {}
• MODAL_CHANGED_PROPERTY {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getBackgroundImage {}
• getBorder {}
• getCloseIcon {}
• getCloseIconInsets {}
• getDefaultCloseOperation {}
• getHeight {}
• getIcon {}
• getIconInsets {}
• getInsets {}
• getMaximumHeight {}
• getMaximumWidth {}
• getMinimumHeight {}
• getMinimumWidth {}
• getPositionX {}
• getPositionY {}
• getTitle {}
• getTitleBackground {}
• getTitleBackgroundImage {}
• getTitleBarInsets {}
• getTitleFont {}
• getTitleForeground {}
• getTitleHeight {}
• getTitleInsets {}
• getWidth {}
• getZIndex {}
• hashCode {}
• isClosable {}
• isModal {}
• isMovable {}
• isResizable {}
• removeWindowPaneListener {WindowPaneListener1}
• setBackgroundImage {FillImage1}
• setBorder {FillImageBorder1}
• setClosable {boolean1}
• setCloseIcon {ImageReference1}
• setCloseIconInsets {Insets1}
• setDefaultCloseOperation {int1}
• setHeight {Extent1}
• setIcon {ImageReference1}
• setIconInsets {Insets1}
• setInsets {Insets1}
• setMaximumHeight {Extent1}
• setMaximumWidth {Extent1}
• setMinimumHeight {Extent1}
• setMinimumWidth {Extent1}
• setModal {boolean1}
• setMovable {boolean1}
• setPositionX {Extent1}
• setPositionY {Extent1}
• setResizable {boolean1}
• setTitle {String1}
• setTitleBackground {Color1}
• setTitleBackgroundImage {FillImage1}
• setTitleBarInsets {Insets1}
• setTitleFont {Font1}
• setTitleForeground {Color1}
• setTitleHeight {Extent1}
• setTitleInsets {Insets1}
• setWidth {Extent1}
• setZIndex {int1}
• toString {}
• userClose {}
  

Goto Top

---

Window

Inherits from Component

Properties

• -backgroundImage
• -horizontalScroll
• -insets
• -verticalScroll
• -public
• -onclose
• -title
• -content
  

Class Procedures

• _getObjType_ {}
  

Methods

• _getObj_ {}
• _getType_ {}
• dispose {}
• equals {Object1}
• getBackgroundImage {}
• getHorizontalScroll {}
• getInsets {}
• getVerticalScroll {}
• hashCode {}
• setBackgroundImage {FillImage1}
• setHorizontalScroll {Extent1}
• setInsets {Insets1}
• setVerticalScroll {Extent1}
• toString {}
• getTitle {}
• setTitle {String1}
• getContent {}
• setContent {ContentPane1}
• getWindowObj {}
• getThisAppObj {}
• exitApp {args}
• setStyleSheetResource {sheetName}
• setDefaultStyle {name}
• setFocusedComponent {widget}
• log {level message}
• getDisplayBgError {}
• getScriptFilename {}
• getClientProperties {}
  

Notes

Window cannot be instantiated. Instead, a Window named "." (dot) is constructed upon application startup and is the root for all other components.

The Window method log takes two parameters, level and message. Level is one of trace, debug, info, warn, error, or fatal. Message is simple a string to be logged.

The Window method exitApp exits the currently running application and redirects the browser to another page. Applications are terminated in one of two ways, an internal method that disposes of the Tcl interpreter and invalidates the session, or an external method that relies on a separate servlet to accomplish the same tasks. The default method to use the interal method. The external method is used when the -logout option is specified. When specifying -logout, the option -app can be specified to name a page within the existing web application (an html page contained in the WAR file being used.)

Here are various ways to invoke the exitApp method:

. exitApp
. exitApp /absolutepage.html
. exitApp http://aejaks.sf.net
. exitApp -logout
. exitApp -logout /index.html
. exitApp -logout http://aejaks.sf.net
. exitApp -logout -app /foo.html   ;# i.e. /aejaks/foo.html

Goto Top

---

Commands

• BrowserCommand
• Download
• Log
• Pack
• TaskQueue
  

---

BrowserCommand

Summary:

BrowserCommand redirect url
BrowserCommand openwindow url windowname features ?-replace?
BrowserCommand setcookie name value ?-domain domain? ?-path path? ?-maxAge seconds?
BrowserCommand jseval javascript-code
BrowserCommand jsinclude url
BrowserCommand print
BrowserCommand setwaitms milliseconds

Where:

• redirect redirects the current browser page to the specified URL
• openwindow opens a new browser window to the specified URL
• setcookie sets a browser cookie
• jseval evaluates javascript code
• jsinclude includes javascript code from a URL
• print causes the browser's Print dialog to open
• setwaitms sets the number of milliseconds to wait before Please Wait
  

Arguments:

• url is a valid URL.
• windowname is an internal window name
• features is a comma separated list of javascript window.open() features
• -replace is an option indicating to replace the window contents
• name is the name of a cookie
• value is the value of a cookie
• domain is a cookie domain value
• path is a cookie path value
• seconds is a integer number of seconds
• milliseconds is a integer number of milliseconds
• javascript-code is a string of Javascript code
  

BrowserCommand performs browser window opening, redirect, set cookie Javascript eval, Javascript include, and print operations.

---

Download

Summary:

Download contentType fileName string
Download contentType fileName -bytearray javaByteArray
Download contentType fileName -file pathName ?-delete?

Arguments:

• contentType is the MIME content type of the data
• fileName is the file name which is suggested as the download file, not the actual file
• string is a Tcl string used as download data
• javaByteArray is a Java byte[] object when using the -bytearray option
• pathName is the actual file to download when using the -file option
• -delete is an optional flag when using the -file option
  

Download causes a file download operation to the client browser. If the download is a file and the -delete flag is set, the file will be removed after the file has been downloaded or the operation canceled by the user.

---

Log

Summary:

Log loglevel message

Arguments

• loglevel is one of trace, debug, info, warn, error, or fatal

1. message is a text string to log
   Log will write a log message to the aejaks_script application log at the specified errorlevel. The Log4j logging system is used to log messages. The default Log4j configuration file is logs/Aejaks_Log4j.xml, relative to the webserver home directory, or as specified by the AEJAKS_LOG_CONFIG_FILE system property. Information on configuring Log4j can be found at http://logging.apache.org/log4j/index.html.
   

---

Pack

Summary:

Pack widget ?widget...? ?layout-options?
Pack configure widget ?widget...? ?layout-options?
Pack forget widget ?widget...?
Pack destroy widget ?widget...?
Pack slaves widget
Pack children widget
Pack parent widget

Where:

• configure places widgets into their parent container. This is the default operation if not specified.
• forget removes widgets from their parent container
• destroy removes the widget from its parent, and destroys the widget and all of its child widgets.
• slaves returns a list of child objects, which are currently packed. Only one parent can be specified.
• children returns a list of child objects, whether or not they are currently packed. Only one parent can be specified.
• parent returns the parent path widget name. Only one widget can be specified.
  

Pack places component widgets into their parent widgets. It is also used to remove components, destroy components, and query slaves (children) and parent widgets.

When packing widgets with configure, layout-data can be specified. The particular layout-options depends on the type of parent container object:

• AccordionPane: -title
• BorderPane: (none)
• Column: -height -alignment -background -backgroundImage -insets
• ContainerEx: -alignment -background -backgroundImage -border -bottom -clearFloat -float -font -foreground -height -inlineLayout -insets -left -mouseCursor -mouseCursorUri -outsets -position -right -toolTipText -top -width -zIndex
• ContentPane: (none)
• ContentPaneEx: -alignment -background -backgroundImage -border -bottom -clearFloat -float -font -foreground -height -inlineLayout -insets -left -mouseCursor -mouseCursorUri -outsets -position -right -scrollBarPolicy -scrollBarBaseColor -toolTipText -top -width -zIndex
• DragSource: (none)
• ExpandableSection: (none)
• Grid: -columnSpan -rowSpan -alignment -background -backgroundImage -insets
• GroupBox: (none)
• MenuBarPane: (none)
• Panel: (none)
• SplitPane: -alignment -background -backgroundImage -insets -maximumSize -minimumSize -overflow
• Row: -width -alignment -background -backgroundImage -insets
• TabPane: -title
• TransitionPane: (none)
• Window: (none)
• WindowPane: (none)
  

Layout-options apply to all widgets packed during the same command. Layout-options may either specify an appropriate object, or constructor arguments to the object.

Layout Objects

• -alignment Alignment
• -background Color
• -backgroundImage FillImage
• -border Border
• -bottom Extent
• -clearFloat type, one of FLOAT_CLEAR_BOTH FLOAT_CLEAR_LEFT FLOAT_CLEAR_NONE FLOAT_CLEAR_RIGHT
• -columnSpan int
• -float type, one of FLOAT_LEFT FLOAT_NONE FLOAT_RIGHT
• -font Font
• -foreground Color
• -height Extent
• -inlineLayout boolean
• -insets Insets
• -left Extent
• -maximumSize Extent
• -minimumSize Extent
• -mouseCursor type, one of CURSOR_AUTO CURSOR_CROSSHAIR CURSOR_CUSTOM_URI CURSOR_DEFAULT CURSOR_E_RESIZE CURSOR_HELP CURSOR_MOVE CURSOR_NE_RESIZE CURSOR_NW_RESIZE CURSOR_N_RESIZE CURSOR_POINTER CURSOR_SE_RESIZE CURSOR_SW_RESIZE CURSOR_S_RESIZE CURSOR_TEXT CURSOR_WAIT CURSOR_W_RESIZE
• -mouseCursorUri UriString
• -outsets Insets
• -overflow type, one of OVERFLOW_AUTO OVERFLOW_HIDDEN OVERFLOW_SCROLL
• -position type, one of STATIC RELATIVE ABSOLUTE FIXED
• -right Extent
• -rowSpan int
• -scrollBarBaseColor Color
• -scrollBarPolicy type, one of UNDEFINED NEVER ALWAYS AUTO CLIPHIDE
• -scrollBarProperties echopointng.able.ScrollBarProperties
• -title String
• -toolTipText String
• -top Extent
• -width Extent
• -zIndex int
  

The number of child widgets that can be packed into a container varies by the container. However, unlimited WindowPane containers may be packed into any other *Pane or Window container.

• AccordionPane, Column, ContainerEx, ContentPaneEx, Grid, GroupBox, Row, TabPane: unlimited
• SplitPane: two
• All others: one
  

The root Window object (".") is configured to contain a ContentPane by default. The root Window ContentPane can be replaced by invoking the setContent method.

---

TaskQueue

Summary:

TaskQueue create
TaskQueue add code
TaskQueue remove
TaskQueue setpollinginterval msec

Where:

• create creates a TaskQueue
• add adds code to be executed
• remove removes the TaskQueue
• setpollinginterval sets the polling interval (default 500ms)
  

Arguments:

• code is the code to execute
• msec is an integer number of milliseconds which the client should poll.
  

TaskQueue is the mechanism by which user interface components can be updated from a background event, typically scheduled with the Tcl after command. TaskQueue should only be created when needed, and removed when no longer required. Echo2 causes the browser to poll the server in order to process commands in the TaskQueue. Polling interval should be set to a value that is appropriate for each application.

Trying to update components directly using Tcl after command will result in an error.

Also note that the JTcl interpreter is shared between user interface event processing and servicing Tcl after commands. Any long-running Tcl command processed during an after event will result in the user interface being blocked until the after event finishes.

---

Library

• aejaks_chooseColor
• aejaks_chooseDate
• aejaks_entryBox
• aejaks_getFile
• aejaks_messageBox
  

---

aejaks_chooseColor

Summary:

aejaks_chooseColor -message text -parent win -title text -color rgb-list -geom geom-list -command script

Where:

• text is a string
• win is a valid Pane window
• rgb-list is a list of three integers: red green blue
• geom-list is list of two integers: width height
• script is a script to execute, taking one argument
  

aejaks_chooseColor creates a modal, non-closable window in which to display a ColorSelect widget and message. The command script is executed with one argument, a list of three integers represent red, green, and blue values of the color selected, or an empty list if the Cancel button was pressed.

The -color rgb-list specifies a default color, if specified, the rgb-list must be a list of three integers, each value must be 0-255. If a -parent window is specified, it must reference a valid *Pane widget, the default is the root window ".". Height and width of the dialog box may be specified, and the -geom value must be a list of two integers.

---

aejaks_chooseDate

Summary:

aejaks_chooseDate -message text -parent win -title text -date milliseconds-obj -time time-sepc -clock clock-spec -geom geom-list -returntype return-spec -command script

Where:

• text is a string
• win is a valid Pane window
• milliseconds-obj is a an long integer number of milliseconds, or a java.util.Date object. default is the current date and time.
• time-spec is a either 0 or 1. 1 specifies that time controls (hour, minute, second) should be displayed. default is 0
• clock-spec is a either 12hr or 24hr, 12 specifies that time controls with am/pm. default is 24hr.
• geom-list is list of two integers: width height
• return-spec is either milliseconds or object. default is object
• script is a script to execute, taking one argument
  

aejaks_chooseDate creates a modal, non-closable window in which to display a CalendarSelect widget and message. The command script is executed with one argument, the date as a number of milliseconds if -returntype milliseconds was specified, a java.util.Date object if -returntype object was specified, or a null string ("") if the Cancel button was pressed. -time 1 can be specified to show hour, minute and second controls. When -time 1 is specifed, -clock 12hr will show the -time control hours as am/pm 1-24, otherwise the hour control shows 0-23 hours.

The -command script argument is required, all other are optional. If a -parent window is specified, it must reference a valid *Pane widget, the default is the root window ".". Height and width of the dialog box may be specified, and the -geom

---

aejaks_entryBox

Summary:

aejaks_entryBox -icon icon -message text -parent win -title text -msgOpts msg-opts -entryOpts entry-opts -geom geom-list -command script

Where:

• icon is one of error, info, question, warning; or icon is an ImageReference object or constructor
• text is a string
• win is a valid Pane window
• type is one of abortretryignore, ok, okcancel, retrycancel, yesno, yesnocancel
• msg-opts is a list of configure options for the Lable message widget
• entry-opts is a list of configure options for the TextField entry widget
• geom-list is list of two integers, width and height
• script is a script to execute, taking two arguments
  

aejaks_entryBox creates a modal, non-closable window in which to display a message, and a single entry box. Upon user input, and pressing Return key or pressing the Ok button, the command script is executed with two arguments, a literal value Ok and the value of the TextField. If the Cancel button is pressed, the command script is executed with two arguments, a literal value Cancel and a null string {}.

The -command script are required. Height and width of the dialog box may be specified, and the -geom value must be a list of two integers. An icon can be specified by one of the four standard icon choices, or an ImageReferenct object or constructor can be specified. If a -parent window is specified, it must reference a valid *Pane widget, the default is the root window ".". -msgOpts specifies any number of configure options for Label message widget. -entryOpts specifies any number of configure options for TextField entry widget.

---

aejaks_getFile

Summary:

aejaks_getFile -message text -parent win -title text -geom geom-list -command script

Where:

• text is a string
• win is a valid Pane window
• geom-list is list of two integers: width height
• script is a script to execute, taking one argument
  

aejaks_getFile creates a modal, non-closable window in which to display an UploadSelect widget and message. The command script is executed with four arguments, status, filename, tempfile, and size. The status is the value from the upload operation as reported by the UploadSelect widget. The filename is the name of the file choosen by the user. The tempname is the actual file uploaded, which must be copied to keep the file. The size is the size of the uploaded file. If the Cancel button was pressed, the four arguments are null strings.

The -command script argument is required, all other are optional. If a -parent window is specified, it must reference a valid *Pane widget, the default is the root window ".". Height and width of the dialog box may be specified, and the -geom value must be a list of two integers.

---

aejaks_messageBox

Summary:

aejaks_messageBox -icon icon -message text -parent win -title text -type type -buttons button-list -msgType msg-type -msgOpts msg-opts -geom geom-list -command script

Where:

• icon is one of error, info, question, warning; or icon is an ImageReference object or constructor
• text is a string
• win is a valid Pane window
• type is one of abortretryignore, ok, okcancel, retrycancel, yesno, yesnocancel
• button-list is a list of alternate button names
• msg-type is either Label (default), TextArea, or DirectHtml
• msg-opts is a list of configure options for the message widget (Label or TextArea)
• geom-list is list of two integers, width and height
• script is a script to execute, taking one argument
  

aejaks_messageBox creates a modal, non-closable window in which to display a message, and present a number of buttons. Upon user selection of a button, the command script is executed with one argument, the name of the button that was pressed. For standard button types, the button names returned are Abort, Retry, Ignore, Ok, Cancel, Yes, or No.

The -command script argument defaults to #, a null command. Either -button button-list or -type type specifies the number and names of the buttons. The default is a single "Ok" button. Height and width of the dialog box may be specified, and the -geom value must be a list of two integers. An icon can be specified by one of the four standard icon choices, or an ImageReferenct object or constructor can be specified. If a -parent window is specified, it must reference a valid *Pane widget, the default is the root window ".". -msgType can specify the type of widget to display the message, Label is the default, TextArea, or DirectHtml can be spedified. -msgOpts specifies any number of configure options for either message widget. For example: -msgType TextArea -msgOpts {-disabledBackground black -disabledForeground red -width 270}

---

aejaks_bgerror

Summary

aejaks_bgerror errmessage

aejaks_bgerror is the default bgerror handler. The default behavior is to log an error message to the aejaks_script log, and if an error is encountered during processing of a action, a windows will be display with the error details.

An application may define its own begerror procedure to handler errors in a specific fashion.

---