Skip to content

Override

philormand edited this page Feb 19, 2018 · 15 revisions

void addButton(String target, String text, String set, String unSet, String jScript, String image)

Adds a button to the page

Parameters

String target : the page to go to
String text : the text to display on the button
String set : the flags to set if the button is pressed
String unSet : the flags to clear if the button is pressed
String jScript : the Java Script function to run if the button is pressed
String image : the background image for the button


void addButton(String target, String text, String set, String unSet, String jScript, String image, String hotKey)

Adds a button to the page

Parameters

String target : the page to go to
String text : the text to be displayed on the button
String set : the flags to set if the button is pressed
String unSet : the flags to clear if the button is pressed
String jScript : the Java Script function to run if the button is pressed
String image : the background image for the button
String hotKey : the hot key assigned to the button


void addButton(String target, String text, String set, String unSet, String jScript, String image, String hotKey, String sortOrder, boolean disabled, String id)

Adds a button to the page

Parameters

String target : the page to go to
String text : the text displayed on the button
String set : the flags to set if the button is pressed
String unSet : the flags to clear if the button is pressed
String jScript : the Java Script function to run if the button is pressed
String image : the background image for the button
String hotKey : the hot key assigned to the button
String sortOrder : the sort order value (used to sort the buttons)
boolean disabled : the disabled state of the button (true to disable it)
String id : the id to use to manipulate the button from Java Script


void addButton(String target, String text, String set, String unSet, String jScript, String image, String hotKey, String sortOrder, boolean disabled, String id, boolean defaultBtn)

Adds a button to the page

Parameters

String target : the page to go to
String text : the text displayed on the button
String set : the flags to set if the button is pressed
String unSet : the flags to clear if the button is pressed
String jScript : the Java Script function to run if the button is pressed
String image : the background image for the button
String hotKey : the hot key assigned to the button
String sortOrder : the sort order value (used to sort the buttons)
boolean disabled : the disabled state of the button (true to disable it)
String id : the id to use to manipulate the button from Java Script
boolean defaultBtn : default button activated when enter is pressed


void addTimer(String delay, String jScript, String imageId, String text, String set, String unSet, String id)

Adds a timer to change various aspects of the screen / run a javascript function

Parameters

String delay : the time in seconds before the timer triggers
String jScript : the Java Script function to run when the timer triggers
String imageId : the image to change to when the timer triggers
String text : the html to set the right html pane to when the timer triggers
String set : the flags to set when the timer triggers
String unSet : the flags to clear when the timer triggers
String id :


void setDelay(String target, String delay, String startWith, String style, String set, String unSet, String jScript)

Add a delay / count down timer

Parameters

String target : the page to go to if the delay counts down to 0
String delay : the number of seconds for the delay Can be a range specify (n..n2) e.g. (5..10) for a random delay between 5 and 10 seconds
String startWith : Don't show the true value but start with a higher one e.g. setting this to 50 with a 5 second delay would show a count starting at 50 but would reach 0 while displaying 45 seconds to go
String style : Display style N Normal display the count down timer S Secret display ??:?? so user knows there is a timer H Hidden don't display anything
String set : the flags to set if the delay counts down to 0
String unSet : the flags to clear if delay counts down to 0
String jScript : the Java Script function to run if delay counts down to 0


void setVideo(String id, String startAt, String stopAt, String target, String set, String unSet, String repeat, String jscript)

Play a video

id : File must be in the media directory (or subdirectory) Wild cards can be used e.g. kate/home*.* would select a video in the sub directory kate with a file name starting with home

startAt : to start 90 seconds in use 00:01:30 stopAt : to stop at 95 seconds into the video 00:01:35

Parameters

String id : the file name for the video
String startAt : the Start time for the video hh:mm:ss
String stopAt : the Stop time for video hh:mm:ss
String target : the page to go to when the video stops
String set : the flags to set when the video ends
String unSet : the flags to clear when the video ends
String repeat : the number of times to repeat the video
String jscript : the Java Script function to run when the video stops


void setAudio(String id, String startAt, String stopAt, String target, String set, String unSet, String repeat, String jscript)

Play an audio file

id : File must be in the media directory (or subdirectory) Wild cards can be used e.g. kate/home*.* would select an audio file in the sub directory kate with a file name starting with home

startAt : to start 90 seconds in 00:01:30 stopAt : to stop at 95 seconds into the video 00:01:35

Parameters

String id : the file name for the audio
String startAt : the start time for the audio hh:mm:ss
String stopAt : the stop time for audio hh:mm:ss
String target : the page to go to when the audio stops
String set : the flags to set when the audio ends
String unSet : the flags to clear when the audio ends
String repeat : the number of times to repeat the audio
String jscript : the Java Script function to run when the audio stops


void setAudio(String id, String startAt, String stopAt, String target, String set, String unSet, String repeat, String jscript, int volume)

Play an audio file

id : File must be in the media directory (or subdirectory) Wild cards can be used e.g. kate/home*.* would select an audio file in the sub directory kate with a file name starting with home

startAt : to start 90 seconds in 00:01:30 stopAt : to stop at 95 seconds into the video 00:01:35

Parameters

String id : the file name for the audio
String startAt : the start time for the audio hh:mm:ss
String stopAt : the stop time for audio hh:mm:ss
String target : the page to go to when the audio stops
String set : the flags to set when the audio ends
String unSet : the flags to clear when the audio ends
String repeat : the number of times to repeat the audio
String jscript : the Java Script function to run when the audio stops
int volume : number between 0 and 100 to set the volume of the audio


void setMetronome(String bpm, int resolution, int loops, String rhythm)

Play a metronome beat

defaults for a simple beats per minute bpm : the number of beats per minute resolution : 4 loops : 0 rhythm : ""

For complex beat patterns you need to set bpm, resolution and rhythm If bpm=60 and beats=4, we have 1 bar per second with 4 beats per bar, so a beat every 0.25 seconds If rhythm="1,5,9,13" we get 4 clicks once per second If rhythm="1,3,5,7,9,11,13" we get 7 clicks once every half second

bpm : can also be a range (30..60) will give a random BPM between 30 and 60

Parameters

String bpm : Beats per minute 60 will give one beat per second
int resolution : Beats per bar (for a "normal" bpm this should be set to 4)
int loops : Number of times to loop the rhythm
String rhythm : list of numbers to set the beat pattern


void setMetronome(String bpm)

Play a metronome beat

bpm : Beats per minute, 60 will give one beat per second can also be a range (30..60) will give a random BPM between 30 and 60

Parameters

String bpm : the number of beats


void setHtml(String html)

Sets the html for the right hand pane

Parameters

String html : the Html to put in the right pane


void setImage(String id)

Sets the image to be displayed in the left pane

File must be in the media directory (or subdirectory) Wild cards can be used e.g. kate/home*.* would select an image in the sub directory kate with a file name starting with home

Parameters

String id : the file name for the image


void setPage(String page)

Over rides the page to go to

Setting this will force a jump to the page

Parameters

String page : the page to go to


void setLeftHtml(String leftHtml)

Will set the left pane to the html provided

Instead of displaying an image the left pane it will display the html

Parameters

String leftHtml : the Html to be displayed in the left pane


void setRightCss(String rightCss)

Over rides the CSS for the right pane

Parameters

String rightCss : the CSS to use instead of the default


void setLeftBody(String leftBody, String leftCSS)

Sets the content of the body node for the left pane

Rather than over ride the whole html this can be used to set just the body This will function in exactly the same way as setting the right html

Parameters

String leftBody : html to replace the contents of the body node
String leftCSS : the CSS to use instead of the default


void setRightHtml(String rightHtml)

Will set the right pane to the html provided

will replace the complete html in the right pane

Parameters

String rightHtml : the Html to be displayed in the right pane


Clone this wiki locally