One or more of the following 3 buttons may be added:
- Back - goes to the previous page in the stack
- Next - goes to the next page in the stack
- Done - hides the stack (usually labelled "Cancel")
For an example of how to use the Page object, see Actions.Window.
| Properties Summary | |
String |
back
Specifies the text to display on the Back button for that page. |
String |
done
Specifies the text to display on the Done button for that page. |
String |
next
Specifies the text to display on the Next button for that page. |
String |
title
Text shown in the window's title bar. |
| Function Summary | |
Button
|
addButton( <String> label )
Adds a Button component with the specified label to this page. |
Checkbox
|
addCheckbox( <String> label )
Adds a Checkbox component with the specified label to this page. |
ComboBox
|
addComboBox( <String> item1 [, <String> item2] [, ...] )
Adds a ComboBox component with the specified items to this page. |
ListControl
|
addListControl( [<boolean> checked [, <boolean> multiselect [, <String> item1 [, <String> item2 [, etc ...]]]]] )
Adds a ListControl component to this page. |
Spacer
|
addSpacer( [<boolean> line] )
Adds a Spacer component with the option of making it visible as a horizontal line. |
Text
|
addText( <String> label )
Adds a Text component with the specified label this page. |
TextArea
|
addTextArea( [<String> text] )
Adds a TextArea component with the optional default text to this page. |
TextField
|
addTextField( <String> text [, <boolean> obscured] )
Adds a TextField component with default text to this page. |
function
|
onBack( <String> current_page )
Handler Function that is called when the user clicks the Back button. |
function
|
onDone( <String> current_page )
Handler Function that is called when the user clicks the Done button. |
function
|
onNext( <String> current_page )
Handler Function that is called when the user clicks the Next button. |
function
|
setError( <String> error_msg )
Shows error_msg as an error message on the page. |
| Properties Detail |
back
String back
-
Specifies the text to display on the Back button for that page. Empty string hides the button.
done
String done
-
Specifies the text to display on the Done button for that page. Empty string hides the button.
next
String next
-
Specifies the text to display on the Next button for that page. Empty string hides the button.
title
String title
-
Text shown in the window's title bar.
| Function Detail |
addButton
Button addButton( <String> label )
- Adds a Button component with the specified label to this page.
-
Parameters:
label - text for the button
-
Returns:
-
the new Button component
addCheckbox
Checkbox addCheckbox( <String> label )
- Adds a Checkbox component with the specified label to this page.
-
Parameters:
label - text for the checkbox
-
Returns:
-
the new Checkbox component
addComboBox
ComboBox addComboBox( <String> item1 [, <String> item2] [, ...] )
- Adds a ComboBox component with the specified items to this page.
-
Parameters:
item1 - first item in the checkbox
item2 - second item in the checkbox
-
Returns:
-
the new ComboBox component
addListControl
ListControl addListControl( [<boolean> checked [, <boolean> multiselect [, <String> item1 [, <String> item2 [, etc ...]]]]] )
- Adds a ListControl component to this page. You can optionally specify
whether or not the items have checkboxes, if the user select multiple entries, and a default list of items.
Note that items added by this method will be neither checked nor selected.
-
Parameters:
checked - true to display a checkbox before each item. The default is false. [optional]
multiselect - true to all the user to check/select multiple items. The default is /false. [optional]
item1 - the first item in the list [optional]
item2 - the second item in the list [optional]
-
Returns:
-
the new ListControl component
addSpacer
Spacer addSpacer( [<boolean> line] )
- Adds a Spacer component with the option of making it visible as a horizontal line.
-
Parameters:
line - true means show horizontal line [optional]
-
Returns:
-
the new Spacer component
addText
Text addText( <String> label )
- Adds a Text component with the specified label this page.
-
Parameters:
label - text to display
-
Returns:
-
the new Text component
addTextArea
TextArea addTextArea( [<String> text] )
- Adds a TextArea component with the optional default text to this page.
-
Parameters:
text - string to initially fill in the textarea [optional]
-
Returns:
-
the new TextArea component
addTextField
TextField addTextField( <String> text [, <boolean> obscured] )
- Adds a TextField component with default text to this page.
-
Parameters:
text - text to initially fill in the textfield
obscured - true to obscure the text with '*' characters [optional]
-
Returns:
-
the new TextField component
onBack
function onBack( <String> current_page )
- Handler Function that is called when the user clicks the Back button.
Overrides the global Actions.Window.onBack() handler.
-
Parameters:
current_page - name of the current page
onDone
function onDone( <String> current_page )
- Handler Function that is called when the user clicks the Done button.
Overrides the global Actions.Window.onDone() handler.
-
Parameters:
current_page - name of the current page
onNext
function onNext( <String> current_page )
- Handler Function that is called when the user clicks the Next button.
Overrides the global Actions.Window.onNext() handler.
Return true to proceed to the next page in the Stack; false to stay on the current page.
-
Parameters:
current_page - name of the current page
setError
function setError( <String> error_msg )
- Shows error_msg as an error message on the page. Blank error_msg clears the error.
-
Parameters:
error_msg - text to display as an error message
|
Klipfolio Dashboard 5 API | ||||||||
| PREV OBJECT NEXT OBJECT | FRAMES NO FRAMES | ||||||||
| SUMMARY: PROPERTY | FUNCTION | DETAIL: PROPERTY | FUNCTION | ||||||||
© 2009 Klipfolio Inc. All Rights Reserved.