REFERENCE GUIDE      
example method parameters notes
Widget
addActionTarget="widget01,loadgui,panel.xml" addActionTarget String widget_name, String event, String url Used to invoke actions on specific events. Valid events are loadgui, loadurl, invoke
addImage="images/mac.gif,15,15" addImage String str, int w, int h add an image of a given width and height to this widget. See also setImageContainer
addToLocation="100,0" addToLocation int dx, int dy dx and dy are added to current coordinates x and y
addToSize="10,10" addToSize int dw, int dh dw and dh are added to the current size of widget
attachToWidget="widget01,true,true,true,true" attachToWidget String widget_name, boolean x, boolean y, boolean width, boolean height Attach widgets to another widgets. if 'x' is true then whenever the widget we are attached to has its x value modified than this widget will get its x value modifed by the same amount. the same applies for the y attribute. If 'width' is true and the widget we are attached to has its width changed then this widget's 'x' value gets modifed by the same amount.
fireable="true" fireable boolean flag Advanced control, used in popups to prevent action from bieng fired, I.e. when clicking on a scrollbar within the popup, it should not register as a selectio
loadGui="panel23.xml,true" loadGui URL url, boolean update loads a new gui file into this widget, if update is false then it first removes ALL widgets then adds the new gui, if update is true then then the widgets are matches by name, then their properties are updated
preload="images/mac.gif,images/banner.gif" preload String str To prevent a pause on mouse rollovers you may preload images. NOTE: when invoking remember to use %2c instead of a comma otherwise you will get a parsing error
removeWidget="widget04" removeWidget String str removes the child widget named by 'str'. Only removes direct children and NOT grand children or great grandchildren
requestFocus="widget05" requestFocus String source Request focus to be set to the widget named by 'source'
setAlign="left" setAlign String str Sets alignment of text within a widget. Valid values are: left, topleft, top, topright, right, bottomright, bottom, bottomleft. NOTE: If set this property is inherited by its children.
setAnchor="true,false,true,false" setAnchor boolean left, boolean top, boolean right, boolean bottom Layout a widget in relation to its parent. These properties are inheritable. For more info see idiom 2 under blueprints. NOTE: If set this property is inherited by its children.
setBackground="ffffff" setBackground String color Paint the background of widget by passing a hexadecimal string vaue representing RGB as rrbbgg, OR by using the color name, valid values are: red, blue, green, black, white, lightgray, gray, darkgray, yellow, orange, pink, cyan, magenta. NOTE: if setOpaque="false" then the background is not displayed. This is an optimization to prevent redundant painting if the control, especially if the child control has the same background color as the parent control. NOTE: If set this property is inherited by its children.
setBackgroundHighlight="ff0000" setBackgroundHighlight String color Paint the highlight background 'color'. Whenever the mouse rolls over the background is set to this color. See also setBackground. NOTE: if setOpaque="false" then the highlight color will not display.
setBackgroundSelect="00ff00" setBackgroundSelect String color Paint the selection background 'color'. Whenever this control is selected, either as a 'sticky' control or as an item then this color is set. See also setBackground.
setBorder="roundraised" setBorder Set the border of the control. Valid values are: none, flat, squareraisedthin, squareloweredthin, roundraisedthin, roundloweredthin, squareraised, squarelowered, text, groove, ridge, roundraised, roundlowered. NOTE: If set this property is inherited by its children.
setCache="false" setCache boolean cache If set to true, instructs the widget to store the 'gui' once loaded. NOTE: Default setting is true. NOTE: If the data is dynamically generated from the database, the cache should be set to false.
setData="widget01%2cwidget02" setData String str Specifies all the data that is 'submitted' when calling loadGui or loadURL. This parameter takes a comma seperated list of all controls that you wish to submit (retrieving their labels, except for checkbox and radio where it retrieves a value of 1 or 0 for true or false. Note: Remember to encode the comma to %2c when calling this method.
setDataGetSelected="true" setDataGetSelected boolean flag If true it will ONLY pass along the 'selected' items. In the case of checkboxes or radio then the items that are 'set' are passed along.
setEnabled="false" setEnabled boolean flag Disables this control so the user cannot interact with it. Also changes the color to light gray to visually represent a disabled control. NOTE: If set this property is inherited by its children
setFocusTraversable="false" setFocusTraversable boolean flag Indicates whether this control is focus traversable. Will be part of the focus chain of this panel. NOTE: the focus traversable does NOT drill down, only traverse within a single layer. NOTE: if focustraversable is true, there is an additional rectanglar line reserved for highlighting the control when it is focused.
setFontName="serif" setFontName String name Set the font name of this control. Valid values are: serif, sansserif, monospaced, dialog, dialoginput, symbol. NOTE: If set this property is inherited by its children.
setFontSize="12" setFontSize int size Set the font point size of this control. NOTE: If set this property is inherited by its children.
setFontStyle="bold" setFontStyle String style Set the font style of this control. Valid values are: bolditalic, italic, bold, plain, underline, boldunderline, italicunderline, bolditalicunderline. NOTE: If set this property is inherited by its children
setForeground="red" setForeground String color Paint the foreground of the widget. This sets the text color of the control in default mode (not currently selected, highlightable, disabled). See also setBackground. NOTE: If set this property is inherited by its children.
setGroup="groupradio1" setGroup String group Assign this control to a group. This is used for grouping radio buttons or 'sticky' buttons, this enforces a single widget bieng 'set' within the group
setHeight="25" setHeight int x set the height of the control. Useful when in a listbox or tree when you do not wish to change the width of the control.
setHighlight="true" setHighlight boolean flag Makes the widget highlightable (upon mouse over the control is highlighted, colors are settable). NOTE: This is only settable for 'actionable' items, like buttons and items.
setImageContainer="10,10" setImageContainer int width, int height If more than one image is added to the widget than you can set The size of the container to separate the image. NOTE: The images are always placed equi-distant from each other. NOTE: setImageRollover and setImageDown ASSUMES 1 image only.
setImageDown="images/img03.gif" setImageDown String filename Use 'this' image whenever the mouse button is pressed.
setImageRollover="images/img04.gif" setImageRollover String filename Use 'this' image whenever the mouse 'enters' this control
setInsets="4,2,2,2" setInsets int left, int top, int right, int bottom Pad the text a certain distance from the border of the control. NOTE: the default setting is 2,2,2,2
setLabel="hello world" setLabel String label Set the label of this control.
setLocation="20,10" setLocation int x, int y Set the x and y coordinates of this control. This is NOT the absolute coordinate system but relative to the parent it is placed in. See also setShape.
setMinimumSize="20,20" setMinimumSize int w, int h Used to set the smallest size this widget can become. Used in conjunction with DragResize. NOTE: default settings is negative values this the widget can disappear if made too small.
setName="widget01" setName String name Set the name of this control. Used in conjunction with actionable items, attachments etc…
setOpaque="false" setOpaque boolean flag If set than this control will paint its own background. If an object is NOT opaque is the same as saying it is see through (no background is drawn)
setRollover="true" setRollover boolean flag If set than whenever the mouse enters the control the border becomes visible.
setSelected="true" setSelected boolean flag If set than the contol is highlighted to indicate its selected state. Used in conjunction with items and sticky buttons.
setShape="20,10,80,25" setShape int x, int y, int width, int height Set the location and size of the control. See setLocation and setSize
setSize="40,20" setSize int width, int height Set the width and height of the control. See also setShape
setValue="true" setValue boolean flag Used to set the value of this control. Used for checkboxes and radio buttons
setVisible="false" setVisible boolean flag Make a control visible or invisible. NOTE: If set this property is inherited by its children
setWidth="120" setWidth int w Set the width of the control
Button extends Widget
setSticky="true" setSticky boolean flag Used to indicated that this button is a toggle switch. It can be set on or off. In exactly the same fashion as a checkbox
setStuck="true" setStuck boolean flag Used to set the value to true and make a button start out in the 'selected' mode. If true then button is pressed down and selected
Calendar extends Widget
setCalendar="2002,12" setCalendar int year, int month Set the month and and year of this calendar control.
setDate="31" setDate int day Select the day of this calendar control. The selected day is based upon the currently selected year and month.
setMonth="12" setMonth int month Select the month for this calendar. See also setCalendar
setYear="2002" setYear int year Select the year for this calendar. See also setCalendar.
Checkbox extends Button
setBackgroundThumb="yellow" setBackgroundThumb String color Set the background color of the thumb. See also setBackground.
Combobox extends Button
N/A N/A  
DragResize extends Widget
setResize="bottomright" setResize String str If this value is not set then it acts as a drag bar for the parent, otherwise it will resize the parent. Valid values are: left, topleft, top topright, right, bottomright, bottom, bottomleft. These values relate to the manner in which the parent control is settable. NOTE: ensure that the widget is attached properly to the parent otherwise when resizing unexpected behaviour can occur. i.e. setResize="bottomright" then setAttachmenrs="false,false,true,true"
Edit extends Widget
insert="a" insert char c Not really useful but you can add a character into the edit, might as well use setLabel
setAlphaNumeric="true" setAlphaNumeric boolean flag Set the edit control to only accept alphanumeric values. If  set to true then the edit control will only accept A-Z a-z 0-9 to be typed into the control
setCaret="3" setCaret int caret Set the cursor to a specific location within the text in the edit control. NOTE: setLabel first before setCursor.
setLabelLength="100" setLabelLength int length Set the max label length of this widget. Prevents users from typing in excessively long labels if lets say the database values are of a fixed length.
setNumeric="true" setNumeric boolean flag Set the edit control to only accept numeric values. if set to true then only allow the digits 0-9 to be typed into the control
setPassword="true" setPassword boolean flag Set the edit control to be a password field. if true then hides cursor and display only stars
setSelect="2,5" setSelect int start, int end Set a length of text to be selected. If 1,1 then nothing is selected, if 2,3 then the 2nd character is selected, etc..
Item extends Button
setCollapse="true" setCollapse boolean flag Sets whether the item is expanded (its children are visible) or collapsed (its children are hidden)
setCollapseDown="images/img03.gif" setCollapseDown String filename Set the image for the collapsed item when the mouse is pressed
setCollapseRollover="images/img04.gif" setCollapseRollover String filename Set the image for the collapsed item when the mouse enters the control
setExpandDown="images/img05.gif" setExpandDown String filename Set the image for the expanded item when the mouse is pressed
setExpandRollover="images/img06.gif" setExpandRollover String filename Set the image for the expanded item when the mouse enters the control
setImageCollapse="images/img07.gif" setImageCollapse String filename Set the default image for the collapsed item
setImageExpand="images/img08.gif" setImageExpand String filename Set the default image for the expanded item
Listbox extends Widget
setFlat="true" setFlat boolean flag border has to be text, slightly modifies and softens the border
setSortType="2" setSortType int type N/A
Radio extend Checkbox
N/A N/A  
Scrollbar extends Widget
setBackgroundThumb="green" setBackgroundThumb String color Set the background of the thumb in the control. See setBackground
setBorderThumb="flat" setBorderThumb String border Set the border of the thumb in the control. See setBorder
setVertical="false" setVertical boolean flag Set the scrollbar alignment. 'true' then the scrollbar is vertical. 'false' then the scrollbar is horizontal
Splitter extends Widget
setThumbBorder="roundraised" setThumbBorder String border Set the border if the draggable thumb (the bar that splits the two views). See also setBorder
setThumbWidth="8" setThumbWidth int width Set the width of the bar that seperates the two views. If the bar is horizontal than this value sets the height of the bar.
setVertical="false" setVertical boolean flag Set the alignment of the splitter. If 'true' then the bar is vertical, panel 1 is placed on the left and panel 2 is placed on the right. If 'false' then the bar is horizontal and panel 1 is placed on top and panel 2 is placed on the bottom.
Tab
N/A N/A  
TabControl
setTabSelect="2" setTabSelect   Set the tab to be selected.
TabPanel
setTabSelect="2" setTabSelect   Set the tab to be selected.
View
N/A N/A  


[Home][Tutorial 2.0]
Archives Resources Introduction Tutorials 1.6