Spiderscript Home
Class Index | File Index

Classes




Spiderscript Home
Class Index | File Index

Classes




Class SS.control.imagetoggle

Image Toggle. Control which toggles between two or more images when clicked on
Defined in: SS.control.imagetoggle.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
id
Identifier of the dropzone control.
 
Field to link the value to
 
Function called or evaluated {String} whenever the image is changed.
 
Selected value
 
van
Value attribute name
 
Flag to indicate whether or not the imagetoggle is currently visible.
Method Summary
Method Attributes Method Name and Description
 
nextImage(f, q, v)
Selects and returns the next image in the sequence
 
Renders the imagetoggle on the page.
 
selected(v, e)
Selects and returns the next image in the sequence
Class Detail
SS.control.imagetoggle()
Field Detail
id
Identifier of the dropzone control.

linkto
Field to link the value to

onchange
Function called or evaluated {String} whenever the image is changed.

value
Selected value

van
Value attribute name

visible
Flag to indicate whether or not the imagetoggle is currently visible. Overrides style="display:none;" rule on initial render. Default = true.
Method Detail
{HTMLElement} nextImage(f, q, v)
Selects and returns the next image in the sequence
Parameters:
{Boolean} f
Select first flag
{Boolean} q
Query only, do not change to next image
{String} v
Set image
Returns:
{HTMLElement} Selected image.

render()
Renders the imagetoggle on the page.
Returns:
null

{HTMLElement} selected(v, e)
Selects and returns the next image in the sequence
Parameters:
{Boolean} v
Set selected image. (Optional)
{Event} e
Event that raises the selected function. (Optional)
Returns:
{HTMLElement} Selected image.

Documentation generated by JsDoc Toolkit 2.1.0 on Wed Sep 30 2009 09:31:09 GMT+0100 (BST)