Appendix C
Inter Widget Communication allows one Amulet widget to invoke the methods
of another Amulet widget. (See Appendix B for a
comprehensive listing of all available function calls.). Below you will find
a description of the valid IWC methods for each widget, in addition to a brief
description of how those methods specifically act.
Click on the following links to jump to the specific widget's IWC methods:
Widgets:
Objects:
Notes:
BarGraph
- disappear() - Makes the BarGraph not visible on the LCD.
- forceUpdate() - Forces the BarGraph to call its href function
immediately, regardless of the updateRate.
- reappear() - Makes the BarGraph visible on the LCD. Counteracts the
disappear() method.
- setValue(x) - BarGraph uses x as
its input. This allows a Control Widget to provide the input to a BarGraph.
- setMethod(m) - Changes the method originally specified by
the BarGraph's href parameter.
- setUARTMethod(m)
- Changes the UART method originally specified by
the BarGraph's href parameter.
- setUpdateRate(f) - Changes the update rate originally specified by the BarGraph, the argument being a floating point number, specifying the time in seconds.
- setVariableNumber(x) - Changes the variable number originally
specified by a BarGraph. Can only be used if the BarGraph href is byte(y).value()
or
word(y).value(). In either case, the y gets changed to the argument
specified in setVariableNumber(x).
- setX(x) - Sets the x-coordinate of the topleft
corner of the BarGraph to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the BarGraph to the coordinate specified by the word x.
- startUpdating() - BarGraph starts graphing based upon its input data. Counteracts
the stopUpdating() method.
- stopUpdating() - BarGraph stops graphing.
- toggleUpdating() - Changes current state of BarGraph; either starts
or stops graphing.
CheckBox
- disappear() - Makes the CheckBox not visible or touchable on the
LCD.
- forceHit() - CheckBox performs its "hit" method without
user input. The "hit" method will invoke all href functions of the
CheckBox.. When imparting a forceHit on a single CheckBox, that CheckBox will
toggle. You can also forceHit an entire CheckBox group which will perform
the href function(s), but will not toggle any checkboxes. To forceHit a CheckBox
group, use the groupName as the widgetName (rather than the
individual CheckBox name).
- forceUpdate() - Forces the CheckBox group to call its initHref function
immediately. Only valid if initialCondition is FromInitHref.
Updates the CheckBox group and performs a "hit". To forceUpdate a CheckBox
group, use the groupName as the widgetName (rather than the
individual CheckBox name).
- maskedValue(y) - Sends the intrinsic value of the CheckBox to the calling
widget.. The calling object then uses that value, ANDed with the mask y,
as its input. This method is only valid if the intrinsic value is
a byte or word. The mask y can be either a byte or word. This allows
a CheckBox to provide the input to a View Widget. This method is called
from a View Widget href.
- reappear() - Makes the CheckBox visible and touchable on the LCD.
Counteracts the disappear() method.
- setValue(x) - The CheckBox intrinsic value is changed to
x.
- setMethod(m) - Changes the method originally specified by
the CheckBox's href parameter; only valid when the originally specified method is a single
function. To change the
method for a CheckBox group, or an ungrouped CheckBox, use the groupName
as the widgetName (rather than in individual CheckBox name). You cannot
change the method for an individual CheckBox within a group.
- setUARTMethod(m) - Changes the UART method originally specified by
the CheckBox's href parameter; only valid when the originally specified method is a single
function. To change the
method for a CheckBox group, or an ungrouped CheckBox, use the groupName
as the widgetName (rather than in individual CheckBox name). You cannot
change the method for an individual CheckBox within a group.
- setVariableNumber(x) - Changes the variable number originally
specified in the href function to x. Can only be used only if the Check
Box href uses byte(y), word(y) or string(y). In all three
of the cases, the value y is replaced with the value x. Only valid when the originally specified method is a single
function. Can only be used on a Check Box Group, not an individual CheckBox.
- setX(x) - Sets the x-coordinate of the topleft
corner of the individual CheckBox to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the individual CheckBox to the coordinate specified by the word x.
- value() - Sends the intrinsic value of the CheckBox to the calling
widget.. The calling object then uses that value as its input. This allows
a CheckBox to provide the input to a View Widget. This method is called
from a View Widget href.
Custom Button
- buttonDown() - Sets the Custom Button Widget to look like
it is its down state. This method does NOT invoke the href
functions. It only affects the looks of the button, not the functionality.
- buttonUp() - Sets the Custom Button Widget to look like
it is its up state. This method does NOT invoke the href
functions. It only affects the looks of the button, not the functionality.
- disappear() - Makes the Custom Button not visible or touchable on
the LCD.
- forceHit() - Custom Button performs its "hit" method without
user input. The "hit" method will invoke all href functions of the
Custom Button.
- forceUpdate() - Forces the Custom Button to call its initHref function
immediately. Only valid if label is fromInitHref. Updates the Custom
Button label without performing a "hit".
- maskedValue(y) - Sends the intrinsic value of the Custom Button to the
calling widget. The calling object then uses that value, ANDed with the
mask y, as its input. This method is only valid if the intrinsic
value is a byte or word. The mask y can be either a byte or
word. This
allows a Custom Button to provide the input to a View Widget. This method
is called from a View Widget href.
- reappear() - Makes the Custom Button visible and touchable on the
LCD. Counteracts the disappear() method.
- setMethod(m) - Changes the method originally specified by
the Custom Button's href parameter; only valid when the originally specified method is a single
function.
- setUARTMethod(m) - Changes the UART method originally specified by
the Custom Button's href parameter; only valid when the originally specified method is a single
function.
- setValue(x) - The Custom Button intrinsic value is changed to
x.
- setVariableNumber(x) - Changes the variable number originally
specified in the href function to x. Can only be used only if the Custom
Button href uses byte(y), word(y) or string(y). In
all three of the cases, the value y is replaced with the value
x. Only valid when the originally specified method is a single
function.
- setX(x) - Sets the x-coordinate of the topleft
corner of the individual Custom Button to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the individual Custom Button to the coordinate specified by the word x.
- value() - Sends the intrinsic value of the Custom Button to the
calling widget. The calling object then uses that value as its input. This
allows a Custom Button to provide the input to a View Widget. This method
is called from a View Widget href.
Custom Slider
- disappear() - Makes the Custom Slider not visible or touchable on the LCD.
- forceHit() - Custom Slider performs its "hit" method without user
input. The "hit" method will invoke all href functions of that object.
- forceUpdate() - Forces the Custom Slider to call its initHref function
immediately. Only valid if initialCondition is FromInitHref.
Updates the Custom Slider and performs a "hit".
- maskedValue(y) - Sends the intrinsic value of the Custom
Slider to the calling
widget. The calling object then uses that value, ANDed with the mask y, as its input. This
method is only valid if the intrinsic value is a byte or word. The
mask y can be either a byte or word. This allows
a Control object to provide the input to a View Widget. This method is called
from a View Widget href.
- reappear() - Makes the Custom Slider visible and touchable on the LCD. Counteracts
the disappear() method.
- setValue(x) - The Custom Slider intrinsic value is changed to
x.
- setMethod(m) - Changes the method originally specified by
the Custom Slider's href parameter; only valid when the originally specified method is a single function.
- setUARTMethod(m) - Changes the UART method originally specified by
the Custom Slider's href parameter; only valid when the originally specified method is a single function.
- setVariableNumber(x) - Changes the variable number originally
specified in the href function to x. Can only be used only if the Custom
Slider href uses byte(y),
word(y) or string(y). In all three of the cases, the
value y is replaced with the value x. Only valid when the originally specified method is a single
function.
- setX(x) - Sets the x-coordinate of the topleft
corner of the Custom Slider to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Custom Slider to the coordinate specified by the word x.
- value() - Sends the intrinsic value of the Custom Slider to the calling
widget. The calling object then uses that value as its input. This allows
a Control object to provide the input to a View Widget. This method is called
from a View Widget href.
Dynamic Image
- clearCanvas() - Clears the display where the canvas image resided.
Essentially does an erase of the Dynamic Image Widget. This only affects what
is displayed on the LCD, it does not affect the actual canvas image stored
in flash.
- disappear() - Makes the Dynamic Image not visible on
the LCD.
- reappear() - Makes the Dynamic Image visible on the
LCD. Counteracts the disappear() method.
- reset() - Makes the Dynamic Image redraw its image. Should be called
after loading a new image using the Amulet:loadFlash(reset)
function.
- setX(x) - Sets the x-coordinate of the topleft
corner of the Dynamic Image to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Dynamic Image to the coordinate specified by the word x.
Function Button
- buttonDown() - Sets the Function Button Widget to look like it
is its down state. This method does NOT invoke the href functions.
It only affects the looks of the button, not the functionality.
- buttonUp() - Sets the Function Button Widget to look like it
is its up state. This method does NOT invoke the href functions.
It only affects the looks of the button, not the functionality.
- disappear() - Makes the Function Button not visible or touchable
on the LCD.
- forceHit() - Function Button performs its "hit" method
without user input. The "hit" method will invoke all href functions
of that object.
- forceUpdate() - Forces the Function Button to call its initHref function
immediately. Only valid if label is fromInitHref. Updates the Function Button
label without performing a "hit".
- maskedValue(y) - Sends the intrinsic value of the Function Button to
the calling widget. The calling object then uses that value, ANDed with
the mask y, as its input.
This method is only valid if the intrinsic value is a byte or word.
The mask y can be either a byte or word. This allows a Function Button to provide the input to a View Widget. This method
is called from a View Widget href.
- reappear() - Makes the Function Button visible and touchable on the
LCD. Counteracts the disappear() method.
- setMethod(m) - Changes the method originally specified by
the Function Button's href parameter; only valid when the originally specified method is a
single function.
- setUARTMethod(m) - Changes the UART method originally specified by
the Function Button's href parameter; only valid when the originally specified method is a
single function.
- setValue(x) - The Function Button intrinsic value is
changed to x.
- setVariableNumber(x) - Changes the variable number originally
specified in the href function to x. Can only be used only if the Function Button href uses byte(y),
word(y) or string(y). In all three of the cases, the
value y is replaced with the value x. Only valid when the originally specified method is a single
function.
- setX(x) - Sets the x-coordinate of the topleft
corner of the Function Button to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Function Button to the coordinate specified by the word x.
- value() - Sends the intrinsic value of the Function Button to
the calling widget. The calling object then uses that value as its input.
This allows a Function Button to provide the input to a View Widget. This method
is called from a View Widget href.
Image Bar
- disappear() - Makes the Image Bar not visible on the LCD
- forceUpdate() - Forces the Image Bar to call its href function
immediately, regardless of the updateRate.
- reappear() - Makes the Image Bar visible on the LCD. Counteracts
the disappear() method.
- setMethod(m) - Changes the method originally specified by
the Image Bar's href parameter.
- setUARTMethod(m) - Changes the UART method originally specified by
the Image Bar's href parameter.
- setUpdateRate(f) - Changes the update rate originally specified
by the Image Bar, the argument being a floating point number, specifying time
in seconds.
- setVariableNumber(x) - Changes the variable number originally
specified by an Image Bar. Can be used only if the Image Bar href is byte(y).value()
or
word(y).value(). In either case, the y gets changed to the argument
specified in setVariableNumber(x).
- setValue(x) - Image Bar uses x as its
input. This allows a Control Widget to provide the input to an Image
Bar.
- setX(x) - Sets the x-coordinate of the topleft
corner of the Image Bar to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Image Bar to the coordinate specified by the word x.
- startUpdating() - Image Bar starts graphing based upon its input data. Counteracts
the stopUpdating() method.
- stopUpdating() - Image Bar stops graphing.
- toggleUpdating() - Changes current state of Image Bar; either starts
or stops graphing.
Image Sequence
- disappear() - Makes the Image Sequence not visible on the LCD
- forceRefresh() - Forces the Image Sequence to paint the image
at the next update, even if the incoming value is the same as the current
state. Useful if an anchor is used around an Image Sequence, to force the
image to be the correct polarity. If the image changes while the anchor
is selected, it is possible to have the polarity get swapped. Having the
surrounding anchor href perform this on the Image Sequence will allow the
image to stay correctly synched.
- forceUpdate() - Forces the Image Sequence to call its href function
immediately, regardless of the updateRate.
- reappear() - Makes the Image Sequence visible on the LCD. Counteracts
the disappear() method.
- setMethod(m) - Changes the method originally specified by
the Image Sequence's href parameter.
- setUARTMethod(m) - Changes the UART method originally specified by
the Image Sequence's href parameter.
- setUpdateRate(f) - Changes the update rate originally specified
by the Image Sequence, the argument being a floating point number, specifying
time in seconds.
- setValue(x) - Image Sequence uses x as
its input. This allows a Control Widget to provide the input to an
Image Sequence.
- setVariableNumber(x) - Changes the variable number originally
specified by an Image Sequence. Can be used only if the Image Sequence href
is byte(y).value() or
word(y).value(). In either case, the y gets changed to the argument
specified in setVariableNumber(x).
- setX(x) - Sets the x-coordinate of the topleft
corner of the Image Sequence to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Image Sequence to the coordinate specified by the word x.
- startUpdating() - Image Sequence starts using its input data to
determine which image to display. Counteracts
the stopUpdating() method.
- stopUpdating() - Image Sequence stops using its input data to determine
which image to display.
- toggleUpdating() - Changes current state of Image Sequence; either
starts or stops using its input data to determine which image to display.
Line Graph
- disappear() - Makes the Line Graph not visible on the LCD.
- forceUpdate() - Forces the Line Graph to call its href function
immediately, regardless of the updateRate.
- reappear() - Makes the Line Graph visible on the LCD. Counteracts
the disappear() method.
- reset() - Clears the Line Graph
- setMethod(m) - Changes the method originally specified by
the Line Graph's href parameter.
- setUARTMethod(m) - Changes the UART method originally specified by
the Line Graph's href parameter.
- setUpdateRate(f) - Changes the update rate originally specified
by the Line Graph, the argument being a floating point number, specifying time
in seconds.
- setValue(x) - Line Graph uses x as its
input. This allows a Control Widget to provide the input to a Line Graph.
- setVariableNumber(x) - Changes the variable number originally
specified by an Line Graph. Can be used only if the Line Graph href is byte(y).value()
or
word(y).value(). In either case, the y gets changed to the argument
specified in setVariableNumber(x).
- setX(x) - Sets the x-coordinate of the topleft
corner of the Line Graph to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Line Graph to the coordinate specified by the word x.
- startUpdating() - Line Graph starts plotting based upon its input data. Counteracts
the stopUpdating() method.
- stopUpdating() - Line Graph stops plotting.
- toggleUpdating() - Changes current state of Line Graph; either starts
or stops plotting.
Line Plot
- disappear() - Makes the Line Plot not visible on the LCD.
- forceUpdate() - Forces the Line Plot to call its href function
immediately, regardless of the updateRate.
- reappear() - Makes the Line Plot visible on the LCD. Counteracts
the disappear() method.
- reset() - Clears the Line Plot.
- setMethod(m) - Changes the method originally specified by
the Line Plot's href parameter.
- setUARTMethod(m) - Changes the UART method originally specified by
the Line Plot's href parameter.
- setUpdateRate(f) - Changes the update rate originally specified
by the Line Plot, the argument being a floating point number, specifying time
in seconds.
- setValue(x) - Line Plot uses x as its
input. This allows a Control Widget to provide the input to a Line
Plot.
- setVariableNumber(x) - Changes the variable number originally
specified by an Line Plot. Can be used only if the Line Plot href is byte(y).value()
or
word(y).value(). In either case, the y gets changed to the argument
specified in setVariableNumber(x).
- setX(x) - Sets the x-coordinate of the topleft
corner of the Line Plot to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Line Plot to the coordinate specified by the word x.
- startUpdating() - Line Plot starts plotting based upon its input data. Counteracts
the stopUpdating() method.
- stopUpdating() - Line Plot stops plotting.
- toggleUpdating() - Changes current state of Line Plot; either starts
or stops plotting.
Linear Gauge
- disappear() - Makes the Linear Gauge not visible on the LCD.
- forceUpdate() - Forces the Linear Gauge to call its href function
immediately, regardless of the updateRate.
- reappear() - Makes the Linear Gauge visible on the LCD. Counteracts
the disappear() method.
- reset() - Clears the Linear Gauge.
- setMethod(m) - Changes the method originally specified by
the Linear Gauge's href parameter.
- setUARTMethod(m) - Changes the UART method originally specified by
the Linear Gauge's href parameter.
- setUpdateRate(f) - Changes the update rate originally specified
by the Linear Gauge, the argument being a floating point number, specifying time
in seconds.
- setValue(x) - Linear Gauge uses x as its
input. This allows a Control Widget to provide the input to a Linear Gauge.
- setVariableNumber(x) - Changes the variable number originally
specified by a Linear Gauge. Can be used only if the Linear Gauge href is byte(y).value()
or
word(y).value(). In either case, the y gets changed to the argument
specified in setVariableNumber(x).
- setX(x) - Sets the x-coordinate of the topleft
corner of the Linear Gauge to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Linear Gauge to the coordinate specified by the word x.
List
- disappear() - Makes the List not visible or touchable on the LCD.
- forceHit() - List performs its "hit" method without user
input. The "hit" method will invoke all href functions of that object.
- forceUpdate() - Forces the List to call its initHref function
immediately. Only valid if initialCondition is FromInitHref.
Updates the List and performs a "hit".
- maskedValue(y) - Sends the intrinsic value of the List to the calling
widget. The calling object then uses that value, ANDed with the mask y, as its input. This
method is only valid if the intrinsic value is a byte or word. The
mask y can be either a byte or word. This allows
a Control object to provide the input to a View Widget. This method is called
from a View Widget href.
- nextEntry() - Highlighted box of a list box widget moves to next
entry in the list. Effectively moves the highlighted box down one entry.
Does NOT automatically perform a "hit" method.
- previousEntry() - Highlighted box of a list box widget moves to
previous entry in the list. Effectively moves the highlighted box up one
entry. Does NOT automatically perform a "hit" method.
- reappear() - Makes the List visible and touchable on the LCD. Counteracts
the disappear() method.
- setMethod(m) - Changes the method originally specified by the List's
href parameter;
only valid when the originally specified method is a single function.
- setUARTMethod(m) - Changes the UART method originally specified by the List's
href parameter;
only valid when the originally specified method is a single function.
- setVariableNumber(x) - Changes the variable number originally
specified in the href function to x. Can only be used if the List href uses byte(y),
word(y) or string(y). In all three of the cases, the
value y is replaced with the value x. Only valid when the originally specified method is a single
function.
- setX(x) - Sets the x-coordinate of the topleft
corner of the List to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the List to the coordinate specified by the word x.
- value() - Sends the intrinsic value of the List to the calling
widget. The calling object then uses that value as its input. This allows
a Control object to provide the input to a View Widget. This method is called
from a View Widget href.
Numeric Field
- disappear() - Makes the Numeric Field not visible on the LCD.
- forceUpdate() - Forces the Numeric Field to call its href function
immediately, regardless of the updateRate.
- inverseRegionColor() - Makes the entire Numeric Field (both the
background and the text) display in reverse
video. Counteracts the normalRegionColor() method.
- normalRegionColor() - Makes the entire Numeric Field (both the
background and the text) display in normal
video. Counteracts the inverseRegionColor() method.
- reappear() - Makes the Numeric Field visible on the LCD. Counteracts
the disappear() method.
- setMethod(m) - Changes the method originally specified by
the Numeric Field's href parameter.
- setUARTMethod(m) - Changes the UART method originally specified by
the Numeric Field's href parameter.
- setUpdateRate(f) - Changes the update rate originally specified
by the Numeric Field, the argument being a floating point number, specifying
time in seconds.
- setValue(x) - Numeric Field uses x as
its input. This allows a Control Widget to provide the input to a
Numeric Field.
- setVariableNumber(x) - Changes the variable number originally
specified by an Numeric Field. Can be used only if the Numeric Field href
is byte(y).value() or
word(y).value(). In either case, the y gets changed to the argument
specified in setVariableNumber(x).
- setX(x) - Sets the x-coordinate of the topleft
corner of the Numeric Field to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Numeric Field to the coordinate specified by the word x.
- startUpdating() - Numeric Field starts updating based upon its input data. Counteracts
the stopUpdating() method.
- stopUpdating() - Numeric Field stops updating.
- toggleUpdating() - Changes current state of Numeric Field; either
starts or stops updating.
Radio Button
- disappear() - Makes the Radio Button not visible or touchable on
the LCD.
- forceHit() - Radio Button performs its "hit" method without
user input. The "hit" method will invoke all href functions of that
object. Unlike the CheckBox, a forceHit can only be imparted to an individual
Radio Button, not a Radio Button group.
- forceUpdate() - Forces the Radio Button group to call its initHref function
immediately. Only valid if initialCondition is FromInitHref.
Updates the Radio Button group and performs a "hit".
To forceUpdate a Radio Button group, use the groupName as the widgetName (rather than the
individual Radio Button name).
- maskedValue(y) - Sends the intrinsic value of the Radio Button to the
calling widget. The calling object then uses that value, ANDed with the
mask y, as its input. This method is only valid if the intrinsic
value is a byte or word. The mask y can be either a byte or
word. This
allows a Control object to provide the input to a View Widget. This method
is called from a View Widget href.
- reappear() - Makes the Radio Button visible and touchable on the
LCD. Counteracts the disappear() method.
- setMethod(m) - Changes the method originally specified by
the Radio Button's href parameter; only valid when the originally specified method is a single
function.
- setUARTMethod(m) - Changes the UART method originally specified by
the Radio Button's href parameter; only valid when the originally specified method is a single
function.
- setValue(x) - The Radio Button intrinsic value is changed to
x.
- setVariableNumber(x) - Changes the variable number originally
specified in the href function to x. Can only be used only if the Radio
Button href uses byte(y), word(y) or string(y). In
all three of the cases, the value y is replaced with the value
x. Only valid when the originally specified method is a single
function. Can only be used on an individual Radio Button, not the entire
Radio Button Group.
- setX(x) - Sets the x-coordinate of the topleft
corner of the individual Radio Button to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the individual Radio Button to the coordinate specified by the word x.
- value() - Sends the intrinsic value of the Radio Button to the
calling widget. The calling object then uses that value as its input. This
allows a Control object to provide the input to a View Widget. This method
is called from a View Widget href.
Scribble
- clearCanvas() - Clears the display where the canvas image resided.
Essentially does an erase of the Scribble Widget. This only affects what
is displayed on the LCD, it does not affect the actual canvas image stored
in flash.
- disappear() - Makes the Scribble Widget not visible or touchable on the LCD.
- reappear() - Makes the Scribble Widget visible and touchable on the LCD. Counteracts
the disappear() method.
- reset() - Clears the canvas image currently on the Scribble Widget
and redraws the canvas image stored in flash.
- saveCanvas() - The canvas displayed on the LCD is saved to flash,
overwriting the previous canvas image.
- setLinePattern(x) - Changes the line pattern of the active freehand drawing line
to x.
- setLineWeight(x) - Changes the line weight of the active freehand drawing line, in pixels,
to x.
- setX(x) - Sets the x-coordinate of the topleft
corner of the Scribble Widget to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Scribble Widget to the coordinate specified by the word x.
- uploadImage() - The canvas displayed on the LCD is uploaded to
an external processor using xmodem crc protocol.
The image will be sent in the Amulet Bitmap Format.
Slider
- disappear() - Makes the Slider not visible or touchable on the LCD.
- forceHit() - Slider performs its "hit" method without user
input. The "hit" method will invoke all href functions of that object.
- forceUpdate() - Forces the Slider to call its initHref function
immediately. Only valid if initialCondition is FromInitHref.
Updates the Slider and performs a "hit".
- maskedValue(y) - Sends the intrinsic value of the Slider to the calling
widget. The calling object then uses that value, ANDed with the mask y, as its input. This
method is only valid if the intrinsic value is a byte or word. The
mask y can be either a byte or word. This allows
a Control object to provide the input to a View Widget. This method is called
from a View Widget href.
- reappear() - Makes the Slider visible and touchable on the LCD. Counteracts
the disappear() method.
- setValue(x) - The Slider intrinsic value is changed to
x.
- setMethod(m) - Changes the method originally specified by
the Slider's href parameter; only valid when the originally specified method is a single function.
- setUARTMethod(m) - Changes the UART method originally specified by
the Slider's href parameter; only valid when the originally specified method is a single function.
- setVariableNumber(x) - Changes the variable number originally
specified in the href function to x. Can only be used only if the Slider href uses byte(y),
word(y) or string(y). In all three of the cases, the
value y is replaced with the value x. Only valid when the originally specified method is a single
function.
- setX(x) - Sets the x-coordinate of the topleft
corner of the Slider to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Slider to the coordinate specified by the word x.
- value() - Sends the intrinsic value of the Slider to the calling
widget. The calling object then uses that value as its input. This allows
a Control object to provide the input to a View Widget. This method is called
from a View Widget href.
String Field
- disappear() - Makes the String Field not visible on the LCD.
- forceUpdate() - Forces the String Field to call its href function
immediately, regardless of the updateRate
- inverseRegionColor() - Makes the entire String Field (both the
background and the text) display in reverse
video. Counteracts the normalRegionColor() method.
- inverseStringColor() - Makes the String Field's text string display
in reverse video. Counteracts the normalStringColor() method.
- normalRegionColor() - Makes the entire String Field (both the
background and the text) display in normal
video. Counteracts the inverseRegionColor() method.
- normalStringColor() - Makes the String Field's text string display
in normal video. Counteracts the normalStringColor() method.
- reappear() - Makes the String Field visible on the LCD. Counteracts
the disappear() method.
- setValue(x) - String Field uses x as
an input. This allows a Control Widget to provide the input to a
String Field.
- setMethod(m) - Changes the method originally specified by
the String Field's href parameter.
- setUARTMethod(m) - Changes the UART method originally specified by
the String Field's href parameter.
- setUpdateRate(f) - Changes the update rate originally specified
by the String Field, the argument being a floating point number, specifying
time in seconds.
- setVariableNumber(x) - Changes the variable number originally
specified by a String Field. Can be used only if the String Field href is
byte(y).value() or string(y).value(). In both cases, the y gets changed to the argument
specified in setVariableNumber(x).
- setX(x) - Sets the x-coordinate of the topleft
corner of the String Field to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the String Field to the coordinate specified by the word x.
- startUpdating() - String Field starts updating based upon its input data. Counteracts
the stopUpdating() method.
- stopUpdating() - String Field stops updating.
- toggleUpdating() - Changes current state of String Field; either
starts or stops updating.
Anchor/Area Map
- disappear() - Makes the Anchor/Area Map not touchable on
the LCD.
- forceHit() - Anchor/Area Map will perform its "hit" method
without user input. The "hit" method will invoke all href functions
of that object.
- forceUpdate() - Forces the Anchor/Area Map to call its ONVAR function
immediately.
- maskedValue(y) - Sends the intrinsic value associated with the Anchor/Area
Map to the calling widget. The calling object then uses that value, ANDed
with the mask y, as its
input. This method is only valid if the intrinsic value is a byte or
word. The mask y can be either a byte or word. This allows a Control object to provide the input to a View Widget.
This method is called from a View Widget href.
- reappear() - Makes the Anchor/Area Map touchable on the LCD. Counteracts
the disappear() method.
- reset() - Resets the timers in the anchors.
- setValue(x) - The Anchor/Area Map intrinsic value is
changed to x.
- setMethod(m) - Changes the method originally specified by the
Anchor/Area Map's href parameter;
it is only valid when the originally specified method is
a single function.
- setOnVarMethod(m) - Changes the method originally specified by the
Anchor/Area Map's ONVAR parameter;
it is only valid when the originally specified method is
a single function.
- setOnVarUARTMethod(m) - Changes the UART method originally specified by the
Anchor/Area Map's ONVAR parameter;
it is only valid when the originally specified method is
a single function.
- setOnVarVariableNumber(x) - Changes the variable number originally specified
by the
Anchor/Area Map's onVar parameter. Can be used only if the Anchor onVar
has a byte(y), word(y) or string(y). In all cases, the y gets changed to the argument
specified in setOnVarVariableNumber(x).
- setTrigger(x) - Changes the trigger value originally specified
by the Anchor/Area Map's trigger, trigger.gt or trigger.lt
parameter to the byte value x.
- setUARTMethod(m) - Changes the UART method originally specified by the
Anchor/Area Map's href parameter;
it is only valid when the originally specified method is
a single function.
- setUpdateRate(f) - Changes the update rate originally specified
by the Anchor/Area Map, the argument being a floating point number, specifying
time in seconds.
- setVariableNumber(x) - Changes the variable number originally specified
by the
Anchor/Area Map's href parameter. Can be used only if the Anchor href
has a byte(y), word(y) or string(y). In all cases, the y gets changed to the argument
specified in setVariableNumber(x);
it is only valid when the originally specified method is
a single function.
- setX(x) - Sets the x-coordinate of the topleft
corner of the Anchor/Area Map to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the Anchor/Area Map to the coordinate specified by the word x.
- value() - Sends the intrinsic value associated with the Anchor/Area
Map to the calling widget. The calling object then uses that value as its
input. This allows a Control object to provide the input to a View Widget.
This method is called from a View Widget href.
Animated Image
- disappear() - Makes the image not visible on the LCD.
- fastSpeed() - Increases animation speed.
- oneFrame() - Advances animation one frame.
- pause() - Stops animation.
- play() - Starts animation in current direction.
- playBackwards() - Starts animating backwards.
- playForward() - Starts animating forward.
- reappear() - Makes the image visible on the LCD. Counteracts the
disappear() method.
- regularSpeed() - Normal animation speed.
- setX(x) - Sets the x-coordinate of the topleft
corner of the animated image to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the animated image to the coordinate specified by the word x.
- slowSpeed() - Decreases animation speed.
- superFastSpeed() - Fastest animation speed.
- superSlowSpeed() - Slowest animation speed.
Image
- disappear() - Makes the image not visible on the LCD.
- reappear() - Makes the image visible on the LCD. Counteracts the
disappear() method.
- setX(x) - Sets the x-coordinate of the topleft
corner of the image to the coordinate specified by the word x.
- setY(x) - Sets the y-coordinate of the topleft
corner of the image to the coordinate specified by the word x.
META Refresh Tag
- disappear() - Stops the META Refresh Tag URL from being launched.
- forceHit() - META Refresh Tag will perform its "hit" method
without user input. The "hit" method will invoke all href functions
of the META Refresh Tag.
- forceUpdate() - Forces the META Refresh Tag to call its ONVAR function
immediately.
- maskedValue(y) - Sends the intrinsic value associated with the META
Refresh Tag to the calling widget. The calling object then uses that value,
ANDed with the mask y,
as its input. This method is only valid if the intrinsic value is a
byte or word. The mask y can be either a byte or word. This allows a Control object to provide the input to a View
Widget. This method is called from a View Widget href.
- reappear() - Allows the META Refresh Tag URL to be launched. Counteracts
the disappear() method.
- reset() - Resets timers in the META Refresh Tag.
- setValue(x) - The META Refresh Tag intrinsic value
is changed to x.
- setMethod(m) - Changes the method originally specified by the
META Refresh Tag's URL parameter;
it is only valid when the originally specified method is
a single function. If the URL method uses the UART, then you must
use the setUARTMethod() method.
- setOnVarMethod(m) - Changes the method originally specified by the
META Refresh Tag's ONVAR parameter;
it is only valid when the originally specified method is
a single function. If the ONVAR method uses the UART, then you must use
the setOnVarUARTMethod() method.
- setOnVarUARTMethod(m) - Changes the UART method originally specified by the
META Refresh Tag's ONVAR parameter;
it is only valid when the originally specified method is
a single function. If the ONVAR method does not use the UART, then you must
use the setOnVARMethod() method.
- setOnVarVariableNumber(x) - Changes the variable number originally specified
by the
META Refresh's onVar parameter. Can be used only if the META Refresh onVar
has a byte(y), word(y) or string(y). In all cases, the y gets changed to the argument
specified in setOnVarVariableNumber(x).
- setTrigger(x) - Changes the trigger value originally specified
by the META Refresh's trigger, trigger.gt or trigger.lt
parameter to the byte value x.
- setUARTMethod(m) - Changes the UART method originally specified by the
META Refresh Tag's URL parameter;
it is only valid when the originally specified method is
a single function. If the URL method does not use the UART, then you
must use the setMethod() method.
- setUpdateRate(f) - Changes the update rate originally specified
by the META Refresh Tag, the argument being a floating point number, specifying
time in seconds.
- setVariableNumber(x) - Changes the variable number originally specified
by the META Refresh's URL parameter. Can be used only if the META
Refresh URL
has a byte(y), word(y) or string(y). In all cases, the y gets changed to the argument
specified in setVariableNumber(x);
it is only valid when the originally specified method is
a single function.
- value() - Sends the intrinsic value associated with the META
Refresh Tag to the calling widget. The calling object then uses that value
as its input. This allows a Control object to provide the input to a View
Widget. This method is called from a View Widget href.
Regarding Method Parameters
- Regarding x - For Control Widgets that have intrinsic values,
such as lists and sliders, leave the argument field empty, since the
intrinsic value of the selection will be sent out. Anchors, META Refresh Tags,
Area Maps and Function/Custom Buttons should use x. The range for x is 0-255 (0x00-0xff)
for a BYTE, 0-65535 (0x00-0xffff) for a WORD and strings in double
quotes for STRINGs.
- Regarding m - When setMethod(),setOnVarMethod(),setOnVarUARTMethod()
or setUARTMethod(), is the IWC method, the argument
should be the name of the method you want to set. i.e. disappear() or byte.value().
Notice when dealing with a method that relies on a type (byte, word or string)
you need to include the type separated by a dot and then the method (i.e.
word.value()) instead of just the method by itself.
- Regarding f - For Control Widgets that have intrinsic values,
such as lists and sliders, leave the argument field empty, since the
intrinsic value of the selection will be sent out. Anchors, META Refresh Tags,
Area Maps and Function/Custom Buttons should use f. Like the regular updateRate, use the floating point number to
specify the update rate in seconds. The range for f is 0-655.35.
Amulet HTMLCompiler,
Copyright © 2000-2004 by
Amulet Technologies, LLCBack to Welcome - Contact
Amulet - Amulet Home