Scriptaculous

SUAccess
A SUAccess is xxxxxxxxx.
Instance Variables
printContentOn:
SUAccordion
A SUAccordion is xxxxxxxxx.
Instance Variables
maxVisible: <Object>
visible: <Object>
maxVisible
- xxxxx
visible
- xxxxx
cssClass
example
hide:
initialize
Subclasses should redefine this method to perform initializations on instance creation
isVisible:
maxVisible
maxVisible:
renderBody:component:index:on:
renderHead:component:index:on:
renderNavigationOn:
scriptHide:on:
scriptShow:on:
scriptToggle:on:
show:
Pass control from the receiver to aComponent. The receiver will be temporarily replaced with aComponent. As opposed to #call: sending this message does not block and immediately returns.
toggle:
visible
SUAfter
A SUAfter is xxxxxxxxx.
Instance Variables
printContentOn:
SUAjax
A SUAjax is xxxxxxxxx.
Instance Variables
callback: <Object>
url: <Object>
callback
- xxxxx
url
- xxxxx
addParameter:
Add the request parameter anObject, a single value or an association.
addParameters:
Add multiple request parameters from aCollection.
asynchronous:
Determines whether XMLHttpRequest is used asynchronously or not. Since synchronous usage is rather unsettling, and usually bad taste, you should avoid changing this. Seriously.
callback:
Register aBlock as a primary callback of the receiver. It only makes sense to have a single primary callback registered per instance. Depending on the actual evaluation strategy, see #handle:on:, aBlock will be evaluated with a renderer/script as its first argument.
callback:value:
Register aBlock as a secondary callback. anObject is interpreted as JavaScript on the client-side, the result will be sent back to the server and passed into aBlock. Multiple secondary callbacks can be defined with one receiver.
contentType:
The Content-Type header for your request. You might want to send XML instead of the regular URL-encoded format, in which case you would have to change this.
defaultArguments
defaultResponse
encoding:
The encoding for your request contents. It is best left as is, but should weird encoding issues arise, you may have to tweak it in accordance with other encoding-related parts of your page code and server side.
initialize
Subclasses should redefine this method to perform initializations on instance creation
method:
The HTTP method to use for the request. The other widespread possibility is 'get'.
on:of:
on:of:value:
onComplete:
Triggered at the very end of a request's life-cycle, once the request completed, status-specific callbacks were called, and possible automatic behaviors were processed.
onException:
Triggered whenever an XHR error arises. Has a custom signature: the first argument is the requester, the second is the exception object.
onFailure:
Invoked when a request completes and its status code exists but is not in the 2xy family. This is skipped if a code-specific callback is defined, and happens before onComplete.
onInteractive:
(Not guaranteed) Triggered whenever the requester receives a part of the response (but not the final part), should it be sent in several packets.
onLoaded:
(Not guaranteed) Triggered once the underlying XHR object is setup, the connection open, and ready to send its actual request.
onLoading:
(Not guaranteed) Triggered when the underlying XHR object is being setup, and its connection opened.
onStatus:do:
With anInteger being an HTTP status code for the response. Invoked when the response just completed, and the status code is exactly the one we used in the callback name. Prevents execution of onSuccess / onFailure. Happens before onComplete.
onSuccess:
Invoked when a request completes and its status code is undefined or belongs in the 2xy family. This is skipped if a code-specific callback is defined, and happens before onComplete.
onUninitialized:
(Not guaranteed) Invoked when the XHR object was just created.
parameters
Answer the request parameters of the reciever.
process
processOn:
requestHeaders:
Prototype automatically provides a set of default headers, that this option can override and augment: X-Requested-With, X-Prototype-Version, Accept, and Content-type.
setCanvas:
triggerArgument:callback:
Triggers a JavaScript function argument and passes its value into aBlock.
triggerAutocompleter:
Triggers an autocompleter, not that you need to define a passanger for the list items to make this work.
triggerForm:
Serialize a complete from and trigger all its associated callbacks. Note that the callbacks of submit buttons are ignored to preserve consistency, use the normal callback to trigger specific code evaluation.
triggerFormElement:
Serializing a form element and trigger its associated callback. Note that this might not work for all form elements as one would expect: (1) check-boxes and multi-select lists do not work as Seaside internally depends on other hidden form elements. (2) submit-button callbacks are ignored, instead use the normal callback to trigger specific code evaluation.
triggerPassenger:
triggerSliderCallback:
triggerSortable:callback:
triggerTree:callback:
url
url:
SUAlias
A SUAlias is xxxxxxxxx.
Instance Variables
printContentOn:
SUAllTestLibrary
A SUAllTestLibrary is xxxxxxxxx.
Instance Variables
backgroundGif
demoGif
demologoGif
headerGif
logoGif
menuGif
selectorsToInclude
The files represented by the selectors this method returns will be automatically added to the html <head> if the receiver is added to the respective Seaside application.
This makes only sense for CSS and JS files
styleCss
SUAllTests
A SUAllTests is xxxxxxxxx.
Instance Variables
selected: <Object>
tabs: <Object>
selected
- xxxxx
tabs
- xxxxx
canBeRoot
children
This method is really important. It should return a collection of all subcomponents of the current component that will be rendered in #renderContentOn:. Components that are displayed using #call: are *not* children.
If the contents returned by this method change over time make sure to return them in #states as well, otherwise the back button will fail.
description
initialize
Subclasses should redefine this method to perform initializations on instance creation
renderChildrenOn:
renderContentOn:
renderHeaderOn:
renderMenuOn:
states
Answer a collection of states that should be backtracked.
title
updateRoot:
This method allows you customize the <head> section of an HTML document. The API is very similar to the 'Canvas API' for rendering in the <body> section (where you 'draw' in #renderContentOn:).
anHtmlRoot is an instance of WAHtmlRoot
Whenever you override this method don't forget to send super
SUApply
A SUApply is xxxxxxxxx.
Instance Variables
arguments: <Object>
arguments
- xxxxx
arguments
arguments:
printContentOn:
SUAssign
A SUAssign is xxxxxxxxx.
Instance Variables
printContentOn:
SUAssignLocal
A SUAssignLocal is xxxxxxxxx.
Instance Variables
printContentOn:
SUAssignment
A SUAssignment is xxxxxxxxx.
Instance Variables
object: <Object>
object
- xxxxx
object
object:
printContentOn:
SUAutocompleter
A SUAutocompleter is xxxxxxxxx.
Instance Variables
element: <Object>
element
- xxxxx
activate
Activate the autocompletion list.
autoSelect:
defaultArguments
defaultPrototype
element
element:
frequency:
hide
Deactivate the autocompletion list.
indicator:
When sending the Ajax request Autocompleter shows this element with Element.show. When the request has been completed it will be hidden with Element.hide.
minChars:
The minimum number of characters required to start the autocompletion.
next
Mark the next entry in the list.
onHide:
onSelected:
Hook for a custom function called after the element has been updated. This function is called after the built-in function that adds the list item text to the input field. The function receives two parameters, the autocompletion input field and the selected item.
onShow:
onUpdate:
Hook for a custom function called after the element has been updated. This function is called instead of the built-in function that adds the list item text to the input field. The function receives one parameter only, the selected item.
previous
Mark the previous entry in the list.
selectClass:
The CSS class name of the elements within the list-items that should be used when copying the text to the text-input.
selectedIndex
Answer the selected index in the list.
tokens:
The token required to separate multiple autocompletion entries in one text-input.
SUAutocompleterTest
A SUAutocompleterTest is xxxxxxxxx.
Instance Variables
text: <Object>
text
- xxxxx
renderContentOn:
renderListOn:
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SUBefore
A SUBefore is xxxxxxxxx.
Instance Variables
printContentOn:
SUBinary
A SUBinary is xxxxxxxxx.
Instance Variables
operator: <Object>
operator
- xxxxx
operator
operator:
printContentOn:
SUCallback
A SUCallback is xxxxxxxxx.
Instance Variables
isEnabled
SUClassBrowser
A SUClassBrowser is xxxxxxxxx.
Instance Variables
category: <Object>
class: <Object>
selector: <Object>
category
- xxxxx
class
- xxxxx
selector
- xxxxx
categories
renderCategoriesOn:
renderCloseOn:
renderContentOn:
renderSelectorsOn:
renderSourceOn:
selectors
setCategory:
setClass:
setSelector:
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SUComponent
A SUComponent is xxxxxxxxx.
Instance Variables
scriptaculous
seaside
SUCondition
A SUCondition is xxxxxxxxx.
Instance Variables
printContentOn:
SUCounterTest
A SUCounterTest is xxxxxxxxx.
Instance Variables
count: <Object>
count
- xxxxx
decrease
increase
initialize
Subclasses should redefine this method to perform initializations on instance creation
renderContentOn:
renderCountOn:
SUCreate
A SUCreate is xxxxxxxxx.
Instance Variables
printContentOn:
SUDecoration
A SUDecoration is xxxxxxxxx.
Instance Variables
owner: <Object>
owner
- xxxxx
owner
owner:
printContentOn:
SUDocument
A SUDocument is xxxxxxxxx.
Instance Variables
close
close:
open:
SUDragDropTest
A SUDragDropTest is xxxxxxxxx.
Instance Variables
cart: <Object>
cart
- xxxxx
cart
inventory
renderCartItemsOn:
renderCartOn:
renderContentOn:
renderInventoryOn:
renderTrashOn:
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SUDraggable
A SUDraggable is xxxxxxxxx.
Instance Variables
constraint:
If set to #horizontal or #vertical the drag will be constrained to take place only horizontally or vertically.
constraintHorizontal
constraintVertical
defaultPrototype
delay:
endEffect:
ghosting:
Clones the element and drags the clone, leaving the original in place until the clone is dropped.
handle:
Sets whether the element should only be draggable by an embedded handle. The value must be an element reference or element id.
hoverclass:
Gives the created Droppables a hoverclass.
initialize
Subclasses should redefine this method to perform initializations on instance creation
onDrag:
onDropped:
onEnd:
onSnap:
onStart:
revert:
If set to true, the element returns to its original position when the drags ends.
revertEffect:
scroll:
scrollSensitivity:
scrollSpeed:
snap:
If set to false no snapping occurs. Otherwise takes the forms [x,y].
startEffect:
zindex:
The css zindex of the draggable item.
SUDroppable
A SUDroppable is xxxxxxxxx.
Instance Variables
accept:
Set accept to a string or an array of strings describing CSS classes. The Droppable will only accept Draggables that have one or more of these CSS classes.
add
To make an element react when a Draggable is dropped onto it.
containment:
The droppable will only accept the Draggable if the Draggable is contained in the given elements (or element ids). Can be a single element or an array of elements.
defaultMethod
defaultPrototype
greedy:
If true stops processing hovering (don't look for other Droppables that are under the Draggable).
hoverclass:
If set, the Droppable will have this additional CSS class when an accepted Draggable is hovered over it.
onDrop:
Called whenever a Draggable is released over the Droppable and the Droppable is accepts it.
onHover:
Called whenever a Draggable is moved over the Droppable and the Droppable is affected (would accept it). The callback gets 2 parameters, the passenger of the draggable and the percentage of overlapping as defined by the overlap option.
overlap:
If set to 'horizontal' or 'vertical' the droppable will only react to a Draggable if its overlapping by more than 50% in the given direction.
overlapHorizontal
overlapVertical
remove
Remove any droppable capabilities from element.
SUEffect
A SUEffect is xxxxxxxxx.
Instance Variables
absolute
appear
Make an element appear. If the element was previously set to display:none; inside the style attribute of the element, the effect will automatically show the element. This means that it must be places under the style attribute of an object, and not in the CSS in the head of the document or a linked file.
blindDown
Simulate a window blind, where the contents of the affected elements stay in place.
blindUp
Simulate a window blind, where the contents of the affected elements stay in place.
defaultMethod
defaultPrototype
direction:
Set the direction of the transition. Values can be either 'top-left', 'top-right', 'bottom-left', 'bottom-right' or 'center' (default). Applicable only on Grow and Shrink effects.
dropOut
Make the element drop and fade out at the same time.
duration:
Duration of the effect in seconds, given as a float. Defaults to 1.0.
endColor:
Sets the color of the last frame of the highlight. This is best set to the background color of the highlighted element.
event
One-shot events that follow timelines defined by effect queues.
fade
Make an element fade away and takes it out of the document flow at the end of the effect by setting the CSS display property to none.
fold
Reduce the element to its top then to left to make it disappear.
fps:
Target this many frames per second. Default to 25. Can't be higher than 100.
from:
Sets the starting point of the transition, a float between 0.0 and 1.0. Defaults to 0.0.
grow
See a demo.
highlight
This effect Flashes a color as the background of an element. It is mostly used to draw attention to a part of the page that has been updated via javascript or AJAX, when the update would not otherwise be obvious.
mode:
Defaults to 'relative', can also be 'absolute', specifies if the element is moved absolutely or relative to its own position.
morph
This effect morphs to a given CSS style rule. It does take orginal styles given by CSS style rules or the style attribute into consideration when calculating the transforms. It works with all length and color based CSS properties, including margins, paddings, borders, opacity and text/background colors.
move
This effect moves an element by modifying its position attributes.
move:
offset:
Negative or positive number of pixels as offset to the top of view.
onAfterFinish:
Called after the last redraw of the effect was made.
onAfterUpdate:
Called on each iteration of the effects rendering loop, after the redraw takes places.
onBeforeStart:
Called before the main effects rendering loop is started.
onBeforeUpdate:
Called on each iteration of the effects rendering loop, before the redraw takes places.
opacity
This effect changes an element's opacity
parallel:
This is a special effect to allow to combine more than one core effect into a parallel effect.
puff
Give the illusion of the element puffing away (like a in a cloud of smoke).
pulsate
Pulsate the element, loops over five times over fading out and in.
pulses:
Control the amount of pulses.
queue:
Sets queuing options. When used with a string, can be 'front' or 'end' or 'with-last' to queue the effect in the global effects queue at the beginning or end, or a queue parameter object that can have {position: 'front/end', scope: 'scope', limit:1}.
relative
restoreColor:
Sets the background color of the element after the highlight has finished.
scale:
This effect changes an elements width and height dimensions and the base for em units. This allows for smooth, automatic relative scaling of elements contained within the scaled element.
scaleContent:
Set whether content scaling should be enabled, defaults to true.
scaleFrom:
Set the starting percentage for scaling, defaults to 100.0.
scaleFromCenter:
If true, scale the element in a way that the center of the element stays on the same position on the screen, defaults to false.
scaleMode:
Either 'box' (default, scales the visible area of the element) or 'contents' (scales the complete element, that is parts normally only visible byscrolling are taken into account). You can also precisely control the size the element will become by assigning the originalHeight and originalWidth variables to scaleMode.
scaleX:
Set whether the element should be scaled horizontally, defaults to true.
scaleY:
Set whether the element should be scaled vertically, defaults to true.
scroll
Scroll page view to element.
shake
Move the element slightly to the left, then to the right, repeatedly.
shrink
Reduce the element to its top-left corner.
slideDown
Simulate a window blind, where the contents of the affected elements scroll up and down accordingly.
slideUp
Simulate a window blind, where the contents of the affected elements scroll up and down accordingly.
squish
Reduce the element to its top-left corner.
startColor:
Sets the color of first frame of the highlight.
style:
Target CSS style rule for a morph transition.
switchOff
Give the illusion of a TV-style switch off.
sync:
Sets whether the effect should render new frames automatically (which it does by default). If true, you can render frames manually by calling the render() instance method of an effect. This is used by Effect.Parallel().
to:
Sets the end point of the transition, a float between 0.0 and 1.0. Defaults to 1.0.
toggle:
Allow for easily toggling elements with an animation.
toggleAppear
toggleBlind
toggleSlide
transition:
Sets a function that modifies the current point of the animation, which is between 0 and 1. Following transitions are supplied: Effect.Transitions.sinoidal (default), Effect.Transitions.linear, Effect.Transitions.reverse, Effect.Transitions.wobble and Effect.Transitions.flicker.
tweenFrom:to:using:
This effect tweens between two values and sets a property or calls a method on an object; or allows for a callback method, which will be automatically bound to the object.
x:
Either the new absolute target of the effect elements top value or the modifier of its current top value, depending on the mode option.
y:
Either the new absolute target of the effect elements top value or the modifier of its current top value, depending on the mode option.
SUEffectsTest
A SUEffectsTest is xxxxxxxxx.
Instance Variables
effects
renderContentOn:
SUElement
The Element object sports a flurry of powerful DOM methods which you can access either as methods of Element (but that's rather old-fashioned now) or directly as methods of an extended element (thanks to Element.extend for that added bit of syntactic sugar).
absolutize
Turns element into an absolutely-positioned element without changing its position in the page layout.
addClassName:
Adds a CSS class to element.
ancestors
Collects all of element's ancestors and returns them as an array of extended elements.
childElements
Collects all of the element's immediate descendants (i.e. children) and returns them as an array of extended elements.
cleanWhitespace
Removes all of element's text nodes which contain only whitespace.
clonePosition:
Clones the position and/or dimensions of source onto element as defined by the optional argument options.
cumulativeOffset
Returns the offsets of element from the top left corner of the document.
cumulativeScrollOffset
Calculates the cumulative scroll offset of an element in nested scrolling containers.
descendantOf:
Checks if element is a descendant of ancestor.
descendants
Collects all of element's descendants and returns them as an array of extended elements.
dimensions
Finds the computed width and height of element and returns them as key/value pairs of an object.
down
down:
down:at:
Returns element's first descendant (or the index anInteger-th one, if anInteger is specified) that matches the css rule aString. If no aString is provided, all descendants are considered. If no descendant matches these criteria, undefined is returned.
elementsByClassName:
Fetches all of element's descendants which have a CSS class of className and returns them as an array of extended elements.
elementsBySelector:
Takes an arbitrary number of CSS selectors (strings) and returns a document-order array of extended children of element that match any of them.
empty
Tests whether element is empty (i.e. contains only whitespace).
fire:
Fires a custom event with the current element as its target.
fire:with:
Fires a custom event with the current element as its target.
firstDescendant
Returns the first child that is an element. This is opposed to firstChild DOM property which will return any node (whitespace in most usual cases).
hasClassName:
Checks whether element has the given CSS className.
height
Finds and returns the computed height of element.
hide
Hides and returns element.
id
id:
identify
Returns element's id attribute if it exists, or sets and returns a unique, auto-generated id.
immediateDescendants
Collects all of the element's immediate descendants (i.e. children) and returns them as an array of extended elements.
insert:
Inserts content before, after, at the top of, or at the bottom of element, as specified by the position property of the argument. If the argument is the content itself, insert will append it to element.
insert:position:
Inserts anObject before, after, at the top of, or at the bottom of element.
insertAfter:
insertBefore:
insertBottom:
insertTop:
makeClipping
Simulates the poorly supported CSS clip property by setting element's overflow value to 'hidden'. Returns element.
makePositioned
Allows for the easy creation of CSS containing block by setting element's CSS position to 'relative' if its initial position is either 'static' or undefined. Returns element.
match:
Checks if element matches the given CSS selector.
next
next:
next:at:
Returns element's following sibling (or the index anInteger-th one, if anInteger is specified) that matches the css rule aString. If no aString is provided, all following siblings are considered. If no following sibling matches these criteria, undefined is returned.
nextSiblings
Collects all of element's next siblings and returns them as an array of extended elements.
offsetParent
Returns element's closest positioned ancestor. If none is found, the body element is returned.
on:do:
Register the handler aBlock for the event aString on the receiving DOM element. Please refer to SUEvent>>#observe:on:do: for further information.
positionedOffset
Returns element's offset relative to its closest positioned ancestor (the element that would be returned by #offsetParent).
previous
previous:
previous:at:
Returns element's previous sibling (or the index anInteger-th one, if anInteger is specified) that matches the css rule aString. If no aString is provided, all previous siblings are considered. If no previous sibling matches these criteria, undefined is returned.
previousSiblings
Collects all of element's previous siblings and returns them as an array of extended elements.
printContentOn:
readAttribute:
Answer the value of element's attribute or null if attribute has not been specified.
recursivelyCollect:
Recursively collects elements whose relationship is specified by aString. aString has to be a property of element that points to a single DOM node. Returns an array of extended elements.
relativize
Turns element into an relatively-positioned element without changing its position in the page layout.
remove
Completely removes element from the document and returns it.
removeAttribute:
Remove attribute aString.
removeClassName:
Removes element's CSS className and returns element.
replace:
Replaces element by the content of the html argument and returns the removed element.
rule:at:
scroll
Scrolls the window so that element appears at the top of the viewport.
select:
Takes a CSS selector and returns an enumerable of extended descendants of element that match aString.
show
Displays and returns element.
siblings
Collects all of element's siblings and returns them as an array of extended elements.
style:
Modifies element's CSS style properties. Styles are passed as a hash of property-value pairs in which the properties are specified in their camelized form.
styleAt:
Returns the given CSS property value of element. property can be specified in either of its CSS or camelized form.
styleAt:put:
Modifies element's CSS style properties. Styles are passed as a hash of property-value pairs in which the properties are specified in their camelized form.
toggle
Toggles the visibility of element.
toggleClassName:
Toggles element's CSS className and returns element.
undoClipping
Sets element's CSS overflow property back to the value it had before Element.makeClipping() was applied. Returns element.
undoPositioned
Sets element back to the state it was before Element.makePositioned was applied to it. Returns element.
up
up:
up:at:
Returns element's first ancestor (or the index anInteger-th one, if anInteger is specified) that matches the css rule aString. If no aString is provided, all ancestors are considered. If no ancestor matches these criteria, undefined is returned.
update:
Replaces the content of element with the provided newContent argument and returns element.
viewportOffset
Returns the X/Y coordinates of element relative to the viewport.
visible
Returns a Boolean indicating whether or not element is visible (i.e. whether its inline style property is set to display: none;)
width
Finds and returns the computed width of element.
wrap:
Wraps an element inside another, then returns the wrapper.
wrap:attributes:
Wraps an element inside another, then returns the wrapper.
writeAttribute:value:
Add or replace attribute aString with anObject.
SUEnumerable
Enumerable provides a large set of useful methods for enumerations, that is, objects that act as collections of values. It is a cornerstone of Prototype.
all:
Determines whether all the elements are boolean-equivalent to true, either directly or through computation by the provided iterator.
allSatisfy:
any:
Determines whether at least one element is boolean-equivalent to true, either directly or through computation by the provided iterator.
anySatisfy:
collect:
detect:
detectMax:
detectMin:
do:
each:
The cornerstone of Enumerable. It lets you iterate over all the elements in a generic fashion, then returns the Enumerable, thereby allowing chain-calling.
find:
Finds the first element for which the iterator returns true.
findAll:
Returns all the elements for which the iterator returned true.
grep:
Returns all the elements whose string representations match the regular expression.
include:
Determines whether a given object is in the Enumerable or not, based on the == comparison operator.
invoke:
invoke:with:
invoke:withAll:
iteratorFor:
iteratorFor:return:
map:
Returns the results of applying the iterator to each element.
max:
Returns the maximum element (or element-based computation), or undefined if the enumeration is empty. Elements are either compared directly, or by first applying the iterator and comparing returned values.
min:
Returns the minimum element (or element-based computation), or undefined if the enumeration is empty. Elements are either compared directly, or by first applying the iterator and comparing returned values.
on:receiver:
pluck:
Optimization for a common use-case of collect: fetching the same property for all the elements. Returns the property values.
printContentOn:
receiver
receiver:
reject:
Returns all the elements for which the iterator returned false.
select:
size
Return the size of the enumeration.
sortBy:
Provides a custom-sorted view of the elements based on the criteria computed, for each element, by the iterator.
SUEvaluator
Initiates and processes an AJAX request. It automatically injects the JavaScript generated during the callback into the page.
defaultResponse
processOn:
SUEvaluatorTest
A SUEvaluatorTest is xxxxxxxxx.
Instance Variables
selector: <Object>
selector
- xxxxx
renderContentOn:
renderEvaluatorOn:
SUEvent
Event management is one of the really sore spots of cross-browser scripting.
True, the prominent issue is: everybody does it the W3C way, and MSIE does it another way altogether. But there are quite a few subtler, sneakier issues here and there waiting to bite your ankle, such as the keypress/keydown issue with KHTML-based browsers (Konqueror and Safari). Also, MSIE has a tendency to leak memory when it comes to discarding event handlers.
defaultArguments
defaultEvent
defaultPrototype
element
Returns the DOM element on which the event occurred.
event
event:
findElement:
Returns the first DOM element with a given tag name, upwards from the one on which the event occurred.
isLeftClick
Determines whether a button-related mouse event was about the left (primary, actually) button.
observe:on:do:
Define event handler aHandlerObject for anEventString.
stop
Stops the event's propagation and prevents its default action from being triggered eventually.
x
Returns the absolute horizontal position for a mouse event.
y
Returns the absolute vertical position for a mouse event.
SUExecuter
This is a simple facility for periodical execution of a function. This essentially encapsulates the native clearInterval/setInterval mechanism found in native Window objects.
callback
callback:
defaultArguments
defaultCallback
defaultFrequency
frequency
frequency:
printContentOn:
SUFactory
I am a factory to create Scriptaculous objects. Actually I should be a Trait.
autocompleter
create:
document
draggable
droppable
effect
element
evaluator
event
form
formElement
formElementObserver
formObserver
function
inPlaceEditor
initializeOn:using:
insertion
logger
on:
on:using:
periodical
periodicalEvaluator
register:
request
responders
script
selector
slider
sortable
sound
stream
updater
window
SUForm
Form is a namespace and a module for all things form-related, packed with form manipulation and serialization goodness. While it holds methods dealing with forms as whole, its submodule Form.Element deals with specific form controls.
disable
Disables the form as whole. Form controls will be visible but uneditable.
elements
Returns a collection of all form controls within a form.
enable
Enables a fully or partially disabled form.
findFirstElement
Finds first non-hidden, non-disabled form control.
focusFirstElement
Gives keyboard focus to the first element of the form.
inputs
Returns a collection of all INPUT elements in a form. Use optional type and name arguments to restrict the search on these attributes.
request
A convenience method for serializing and submitting the form via an SURequest to the URL of the form's action attribute.
reset
Resets a form to its default values.
serialize
Serialize form data to a string suitable for Ajax requests (default behavior) or, if optional getHash evaluates to true, an object hash where keys are form control names and values are data.
submit
SUFormElement
This is a collection of methods that assist in dealing with form controls. They provide ways to focus, serialize, disable/enable or extract current value from a specific control.
activate
Gives focus to a form control and selects its contents if it is a text input.
clear
Clears the contents of a text input.
disable
Disables a form control, effectively preventing its value to be changed until it is enabled again.
enable
Enables a previously disabled form control.
focus
Gives keyboard focus to an element.
present
Returns true if a text input has contents, false otherwise.
select
Selects the current text in a text input.
serialize
Creates an URL-encoded string representation of a form control in the name=value format.
value
Returns the current value of a form control. A string is returned for most controls; only multiple select boxes return an array of values. The global shortcut for this method is $F().
SUFormElementObserver
This class corresponds to the Form.Observer class in the prototype.js library. It is typically instantiated via a canvas, e.g. (html scriptaculous formElementObserver).
See the comment on SUTimedObserver for more details.
defaultPrototype
SUFormObserver
This class corresponds to the Form.Observer class in the prototype.js library. It is typically instantiated via a canvas, e.g. (html scriptaculous formObserver).
See the comment on SUTimedObserver for more details.
defaultPrototype
SUFormTest
A SUFormTest is xxxxxxxxx.
Instance Variables
checkBox: <Object>
mutliSelectList: <Object>
radioButton: <Object>
selectList: <Object>
textArea: <Object>
textInput: <Object>
checkBox
- xxxxx
mutliSelectList
- xxxxx
radioButton
- xxxxx
selectList
- xxxxx
textArea
- xxxxx
textInput
- xxxxx
initialize
Subclasses should redefine this method to perform initializations on instance creation
renderCheckBoxOn:
renderContentOn:
renderLabel:control:model:on:
renderMultiSelectListOn:
renderRadioButtonOn:
renderSelectListOn:
renderTextAreaOn:
renderTextInputOn:
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SUFunction
A SUFunction is xxxxxxxxx.
Instance Variables
arguments: <Object>
return: <Object>
arguments
- xxxxx
return
- xxxxx
argument
arguments
arguments:
asFunction
asFunction:
initialize
Subclasses should redefine this method to perform initializations on instance creation
initializeWithIterator:
on:iterator:
printContentOn:
return
return:
Return anObject after evaluating the receiver.
SUFunctionalTest
A SUFunctionalTest is xxxxxxxxx.
Instance Variables
renderBox:on:
showSource
SUIfThenElse
A SUIfThenElse is xxxxxxxxx.
Instance Variables
falseStatement: <Object>
trueStatement: <Object>
falseStatement
- xxxxx
trueStatement
- xxxxx
falseStatement
falseStatement:
printContentOn:
trueStatement
trueStatement:
SUInPlaceEditor
A SUInPlaceEditor is xxxxxxxxx.
Instance Variables
autoRows:
cancelButton:
cancelControl:
link|button|false
cancelLink:
cancelText:
The text of the link that cancels editing.
clickToEditText:
The text shown during mouseover the editable text.
defaultPrototype
externalControl:
Id of an element that acts as an external control used to enter edit mode. The external control will be hidden when entering edit mode and shown again when leaving edit mode.
externalControlOnly:
fieldPostCreation:
activate|focus|false
formClassName:
formId:
Id of the element to edit.
highlightColor:
The highlight color.
highlightEndColor:
The color which the highlight fades to.
hoverClassName:
htmlResponse:
initialize
Subclasses should redefine this method to perform initializations on instance creation
loadingClassName:
loadingText:
okButton:
okControl:
link|button|false
okLink:
okText:
The text of the submit button that submits the changed value to the server.
onEnterEditMode:
onEnterHover:
onFormCustomization:
onLeaveEditMode:
onLeaveHover:
paramName:
rows:
The row height of the input field, anything greater than 1 uses a multiline textarea for input.
savingClassName:
savingText:
The text shown while the text is sent to the server.
size:
stripLoadedTextTags:
submitOnBlur:
textAfterControls:
textBeforeControls:
textBetweenControls:
triggerInPlaceEditor:
SUInPlaceEditorTest
A SUInPlaceEditorTest is xxxxxxxxx.
Instance Variables
text: <Object>
text
- xxxxx
initialize
Subclasses should redefine this method to perform initializations on instance creation
renderContentOn:
SUInsertion
Insertion provides a cross-browser solution to the dynamic insertion of HTML snippets (or plain text, obviously). Comes in four flavors: After, Before, Bottom and Top, which behave just as expected.
after
Inserts the html into the page as the next sibling of element.
after:
Call anObject directly after the receiver is evaluated.
before
Inserts the html into the page as the previous sibling of element.
before:
Call anObject directly before the receiver is evaluated.
bottom
Inserts the html into the page as the last child of element.
bottom:
defaultArguments
defaultPrototype
top
Inserts the html into the page as the first child of element.
top:
with:
SUJoin
A SUJoin is xxxxxxxxx.
Instance Variables
collection: <Object>
joiner: <Object>
collection
- xxxxx
joiner
- xxxxx
collection
collection:
join:with:
joiner
joiner:
printOn:
Append to the argument, aStream, a sequence of characters that
identifies the receiver.
SULibrary
A SULibrary is xxxxxxxxx.
Instance Variables
builderJs
controlsJs
dragdropJs
effectsJs
prototypeJs
scriptaculousJs
selectorsToInclude
The files represented by the selectors this method returns will be automatically added to the html <head> if the receiver is added to the respective Seaside application.
This makes only sense for CSS and JS files
sliderJs
soundJs
treePatchJs
unittestJs
SULightbox
A SULightbox is xxxxxxxxx.
Instance Variables
lighter
nextPresentersDo:
renderContentOn:
script
The same as #style except that it is for JavaScript. This is rarely used, consider using WAFileLibrary or exernal files instead.
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SULightboxTest
A SULightboxTest is xxxxxxxxx.
Instance Variables
value: <Object>
value
- xxxxx
inform:
Display a dialog with aString to the user until he clicks 'OK'
initialize
Subclasses should redefine this method to perform initializations on instance creation
renderContentOn:
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SULogger
I am a logger class to be used together with FireBug. I have nothing to do with Scriptaculous directly, but I nicely fit in here as everybody should be using FireBug for Script debugging anyway.
assert:
Throw an assertion error if aBlock does not evaluates to true.
assert:equals:
assert:greater:
assert:less:
assert:notEquals:
assert:notGreater:
assert:notLess:
assertFalse:
assertNotNull:
assertNotUndefined:
assertNull:
assertTrue:
assertUndefined:
debug:
error:
Throw a generic Error exception.
info:
log:
log:format:
printContentOn:
warn:
SUMember
A SUMember is xxxxxxxxx.
Instance Variables
name: <Object>
name
- xxxxx
name
Answer a name for the receiver. This is used generically in the title of certain inspectors, such as the referred-to inspector, and specificially by various subsystems. By default, we let the object just print itself out..
name:
SUMorphTest
A SUMorphTest is xxxxxxxxx.
Instance Variables
renderContentOn:
SUNamed
A SUNamed is xxxxxxxxx.
Instance Variables
arguments: <Object>
id: <Object>
method: <Object>
arguments
- xxxxx
id
- xxxxx
method
- xxxxx
arguments
arguments:
defaultArguments
defaultId
defaultMethod
id
id:
method
method:
printContentOn:
printMethodOn:
SUNavigation
A SUNavigation is xxxxxxxxx.
Instance Variables
elements: <Object>
uid: <Object>
elements
- xxxxx
uid
- xxxxx
add:label:
children
This method is really important. It should return a collection of all subcomponents of the current component that will be rendered in #renderContentOn:. Components that are displayed using #call: are *not* children.
If the contents returned by this method change over time make sure to return them in #states as well, otherwise the back button will fail.
cssClass
findIndex:ifAbsent:
initialize
Subclasses should redefine this method to perform initializations on instance creation
renderContentOn:
renderNavigationOn:
uid:at:
SUNegation
A SUNegation is xxxxxxxxx.
Instance Variables
printContentOn:
SUObject
A SUObject is xxxxxxxxx.
Instance Variables
canvas: <Object>
decoration: <Object>
canvas
- xxxxx
decoration
- xxxxx
&
Combine the receiver and anObject with a logical AND.
,
Concatenate the receiver with anObject.
access:
Access the member aString.
addDecoration:
Add a new decoration to the receiver.
after:
Call anObject directly after the receiver is evaluated.
alias:
Uses aString as an alias for the receiver.
apply:
Apply aCollection of arguments.
assign:
Assign anObject to the receiver.
assignLocalTo:
Assign the receiver to a local variable aString.
assignTo:
Assign the receiver to a global variable aString.
before:
Call anObject directly before the receiver is evaluated.
call:
Call the method aString.
call:argument:
Call the method aString with anObject as its argument.
call:arguments:
Call the method aString with aCollection as its arguments.
canvas
Answer the current rendering canvas.
condition:
Treat anObject as a condition to the execution of the receiver.
confirm:
Show a confirmation with the message anObject before evaluating the receiver.
create
Instantiate the receiver.
decoration
Answer the top-level decoration in the receivers decoration stack.
enumerator
Answer an enumerator on the receiver.
every:
Execute the receiver every aDuration.
factory
Answer a factory object for JavaScript objects.
initialize
Subclasses should redefine this method to perform initializations on instance creation
new
not
Negate the receiver logically.
on:
printContentOn:
printOn:
Append to the argument, aStream, a sequence of characters that
identifies the receiver.
property:
Treat anObject as a condition to the execution of the receiver.
render:
render:on:
return:
Return anObject after evaluating the receiver.
session
Answer the current session.
setCanvas:
then:
Evaluates anObject if the receiver treated as a boolean evaluates to true.
then:else:
Evaluates anObject if the receiver treated as a boolean evaluates to true, otherwise evaluate anotherObject.
timeout:
Evaluates the receiver after aDuration.
toJson
Return a JSON string.
toString
Return a debug-oriented string representation of the object.
|
Combine the receiver and anObject with a logical OR.
SUObjectTest
A SUObjectTest is xxxxxxxxx.
Instance Variables
factory: <Object>
factory
- xxxxx
assert:equals:
assertEnumerable:prefix:
effect
element
event
factory
form
formElement
formElementObserver
formObserver
function
insertion
logger
mock
performTest
responders
script
setUp
sound
stream
testArray
testAsUnicode
check if your dialect implements Character >> #asUnicode which returns the Unicode codepoint
testAssociation
testCharacter
testColor
testDateAndTime
testDecorationAccess
testDecorationAfter
testDecorationAlias
testDecorationApply
testDecorationAssign
testDecorationAssignLocalTo
testDecorationAssignTo
testDecorationBefore
testDecorationBinary
testDecorationCall
testDecorationCallArgument
testDecorationCallArguments
testDecorationCondition
testDecorationConfirm
testDecorationCreate
testDecorationEvery
testDecorationNot
testDecorationOrder
testDecorationProperty
testDecorationReturn
testDecorationThenElse
testDecorationTimeout
testDictionary
testDuration
testEffect
testEffectMorph
testEffectMove
testEffectOpacitiy
testEffectParallel
testEffectScale
testEffectToggle
testEffectTween
testElementDisplaying
testElementEnumerating
testElementEvents
testElementGeometric
testElementModifying
testElementModifyingInsert
testElementModifyingReplace
testElementModifyingUpdate
testElementModifyingWrap
testElementNavigationDown
testElementNavigationNext
testElementNavigationPrevious
testElementNavigationUp
testElementQuerying
testElementStylingClasses
testElementStylingStyles
testEventActions
testEventQuerying
testForm
testFormElement
testFormElementObserver
testFormEnumerating
testFormObserver
testFunction
testFunctionArguments
testFunctionReturn
testInsertion
testInsertionBasic
testInsertionShort
testInsertionWith
testInterval
testJoin
testLiteral
testLoggerAssert
testLoggerComparison
testLoggerLogging
testLoggerMessages
testNumber
testPoint
testResponders
testScript
testScriptAdd
testScriptConcatenate
testSelector
testSound
testStreamArgument
testStreamArguments
testStreamCopy
testStreamJavascript
testStreamNew
testStreamNextPut
testStreamNextPutAll
testStreamOn
testStringBasic
testStringEscaping
testStringSpecial
testStringUnicode
SUPeriodical
Periodically performs an AJAX request and updates a container's contents based on the response text. Offers a mechanism for decay, which lets it trigger at widening intervals while the response is unchanged.
decay:
This controls the rate at which the request interval grows when the response is unchanged. It is used as a multiplier on the current period (which starts at the original value of the frequency parameter). Every time a request returns an unchanged response text, the current period is multiplied by the decay. Therefore, the default value means regular requests (no change of interval). Values higher than one will yield growing intervals. Values below one are dangerous: the longer the response text stays the same, the more often you'll check, until the interval is so short your browser is left with no other choice than suicide. Note that, as soon as the response text does change, the current period resets to the original one.
defaultPrototype
frequency:
Okay, this is not a frequency (e.g 0.5Hz), but a period (i.e. a number of seconds). Don't kill me, I didn't write this one! This is the minimum interval at which AJAX requests are made. You don't want to make it too short (otherwise you may very well end up with multiple requests in parallel, if they take longer to process and return), but you technically can provide a number below one, e.g. 0.75 second.
start
If you wish to re-enable it later, just call its start method.
stop
You can pull the brake on a running PeriodicalUpdater by simply calling its stop method.
SUPeriodicalEvaluator
Periodically performs an AJAX request and gives you the ability to update multiple elements on the page with a single callaback. Offers a mechanism for decay, which lets it trigger at widening intervals while the response is unchanged.
decay:
This controls the rate at which the request interval grows when the response is unchanged. It is used as a multiplier on the current period (which starts at the original value of the frequency parameter). Every time a request returns an unchanged response text, the current period is multiplied by the decay. Therefore, the default value means regular requests (no change of interval). Values higher than one will yield growing intervals. Values below one are dangerous: the longer the response text stays the same, the more often you'll check, until the interval is so short your browser is left with no other choice than suicide. Note that, as soon as the response text does change, the current period resets to the original one.
defaultArguments
first arg seems required even though not being used
defaultPrototype
frequency:
Okay, this is not a frequency (e.g 0.5Hz), but a period (i.e. a number of seconds). Don't kill me, I didn't write this one! This is the minimum interval at which AJAX requests are made. You don't want to make it too short (otherwise you may very well end up with multiple requests in parallel, if they take longer to process and return), but you technically can provide a number below one, e.g. 0.75 second.
start
If you wish to re-enable it later, just call its start method.
stop
You can pull the brake on a running PeriodicalUpdater by simply calling its stop method.
SUPeriodicalTest
A SUPeriodicalTest is xxxxxxxxx.
Instance Variables
renderContentOn:
renderTimeOn:
SUProperty
A SUProperty is xxxxxxxxx.
Instance Variables
printContentOn:
SUPrototype
A SUPrototype is xxxxxxxxx.
Instance Variables
options: <Object>
options
- xxxxx
defaultArguments
defaultOptions
defaultPrototype
optionAt:put:
options
printArgumentsOn:
printContentOn:
printPrototypeOn:
SURequest
Initiates and processes an AJAX request.
defaultPrototype
process
processOn:
SUResponders
A repository of global listeners notified about every step of Prototype-based AJAX requests.
defaultArguments
defaultMethod
defaultPrototype
onComplete:
Triggered at the very end of a request's life-cycle, once the request completed, status-specific callbacks were called, and possible automatic behaviors were processed.
onCreate:
onCreate is only available to responders, as it wouldn't make a lot of sense to individual requests: you do know when your code creates them, don't you?
onException:
Triggered whenever an XHR error arises. Has a custom signature: the first argument is the requester, the second is the exception object.
onFailure:
Invoked when a request completes and its status code exists but is not in the 2xy family. This is skipped if a code-specific callback is defined, and happens before onComplete.
onInteractive:
(Not guaranteed) Triggered whenever the requester receives a part of the response (but not the final part), should it be sent in several packets.
onLoaded:
(Not guaranteed) Triggered once the underlying XHR object is setup, the connection open, and ready to send its actual request.
onLoading:
(Not guaranteed) Triggered when the underlying XHR object is being setup, and its connection opened.
onStatus:do:
With anInteger being an HTTP status code for the response. Invoked when the response just completed, and the status code is exactly the one we used in the callback name. Prevents execution of onSuccess / onFailure. Happens before onComplete.
onSuccess:
Invoked when a request completes and its status code is undefined or belongs in the 2xy family. This is skipped if a code-specific callback is defined, and happens before onComplete.
onUninitialized:
(Not guaranteed) Invoked when the XHR object was just created.
register
unregister
SUScript
A SUScript is xxxxxxxxx.
Instance Variables
statements: <Object>
statements
- xxxxx
,
Concatenate the receiver with anObject.
add:
alert:
callback:
effect
element
formElement
goto:
initialize
Subclasses should redefine this method to perform initializations on instance creation
insertion
logger
printContentOn:
refresh
selector
SUSelector
Takes an arbitrary number of CSS selectors (strings) and returns a document-order array of extended DOM elements that match any of them.
add:
Add the selector aString to the receiver.
initialize
Subclasses should redefine this method to perform initializations on instance creation
printContentOn:
selectors
selectors:
SUSlider
A SUSlider is xxxxxxxxx.
Instance Variables
handleId: <Object>
trackId: <Object>
handleId
- xxxxx
trackId
- xxxxx
alignX:
This will move the starting point on the x-axis for the handle in relation to the track. It is often used to move the 'point' of the handle to where 0 should be. It can also be used to set a different starting point on the track.
alignY:
This will move the starting point on the y-axis for the handle in relation to the track. It is often used to move the 'point' of the handle to where 0 should be. It can also be used to set a different starting point on the track.
axis:
Sets the direction that the slider will move in. It should either be horizontal or vertical.
defaultArguments
defaultPrototype
disabled:
This will lock the slider so that it will not move and thus is disabled.
handleId
handleId:
increment:
Defines the relationship of value to pixels. Setting this to 1 will mean each movement of 1 pixel equates to 1 value.
initialize
Subclasses should redefine this method to perform initializations on instance creation
maximum:
The maximum value that the slider will move to. For horizontal this is to the right while vertical it is down.
minimum:
The minimum value that the slider can move to. For horizontal this is to the left while vertical it is up.
onChange:
Called whenever the Slider has finished moving or has had its value changed. The called function gets the slider value as its parameter.
onSlide:
Called whenever the Slider is moved by dragging. The called function gets the slider value as its parameter.
range:
trackId
trackId:
value:
Will set the initial slider value. The handle will be set to this value, assuming it is within the minimum and maxium values.
values:
Accepts an array of integers. If set these will be the only legal values for the slider to be at. Thus you can set specific slider values that the user can move the slider to.
SUSliderTest
A SUSliderTest is xxxxxxxxx.
Instance Variables
position: <Object>
position
- xxxxx
initialize
Subclasses should redefine this method to perform initializations on instance creation
renderContentOn:
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SUSortable
A SUSortable is xxxxxxxxx.
Instance Variables
constraint:
If set to #horizontal or #vertical the drag will be constrained to take place only horizontally or vertically.
constraintHorizontal
constraintVertical
containment:
Enables dragging and dropping between Sortables. Takes an array of elements or element-ids (of the containers).
create
Instantiate the receiver.
defaultMethod
defaultPrototype
delay:
destroy
dropOnEmpty:
If set to true, the Sortable container will be made into a Droppable, that can receive a Draggable (as according to the containment rules) as a child element when there are no more elements inside.
ghosting:
If set to true, dragged elements of the Sortable will e cloned and appear as 'ghost', i.e. a representation of their original element, instead of directly dragging the original element.
handle:
Further restricts the selection of child elements to only encompass elements with the given CSS class (or, if you provide an array of strings, on any of the classes).
hoverclass:
Gives the created Droppables a hoverclass.
initialize
Subclasses should redefine this method to perform initializations on instance creation
onChange:
Called whenever the sort order changes while dragging. When dragging from one Sortable to another, the callback is called once on each Sortable.
onUpdate:
Called when the drag ends and the Sortable's order is changed in any way. When dragging from one Sortable to another, the callback is called once on each Sortable.
only:
Further restricts the selection of child elements to only encompass elements with the given CSS class (or, if you provide an array of strings, on any of the classes).
overlap:
Either ‘#vertical’ or ‘#horizontal’. For floating sortables or horizontal lists, choose ‘#horizontal’. Vertical lists should use ‘#vertical’.
overlapHorizontal
overlapVertical
passengerPrefix
passengerRegexp
scroll:
scrollSensitivity:
scrollSpeed:
sequence
serialize
tag:
Sets the kind of tag (of the child elements of the container) that will be made sortable. For UL and OL containers, this is 'LI', you have to provide the tag kind for other sorts of child tags.
tree
tree:
treeTag:
SUSortableDoubleTest
A SUSortableDoubleTest is xxxxxxxxx.
Instance Variables
left: <Object>
right: <Object>
left
- xxxxx
right
- xxxxx
classForObject:
labelForObject:
left
left:
renderContentOn:
renderList:titled:on:
renderListItems:on:
renderListModel:on:
right
right:
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SUSortableTest
A SUSortableTest is xxxxxxxxx.
Instance Variables
collection: <Object>
collection
- xxxxx
initialize
Subclasses should redefine this method to perform initializations on instance creation
renderContentOn:
renderListItemsOn:
SUSound
A SUSound is xxxxxxxxx.
Instance Variables
defaultMethod
defaultPrototype
disable
enable
play
play:
replace:
track:
url
url:
SUStatement
A SUStatement is xxxxxxxxx.
Instance Variables
statement: <Object>
statement
- xxxxx
on:
statement
statement:
SUStream
A SUStream is xxxxxxxxx.
Instance Variables
stream: <Object>
stream
- xxxxx
argument:
argumentAt:
arguments:
contents
copy
Answer another instance just like the receiver. Subclasses typically override postCopy; they typically do not override shallowCopy.
encode:to:
initialize
Subclasses should redefine this method to perform initializations on instance creation
javascript:
new
nextPut:
nextPutAll:
on:
printOn:
Append to the argument, aStream, a sequence of characters that
identifies the receiver.
stream
SUTabPanel
A SUTabPanel is xxxxxxxxx.
Instance Variables
selected: <Object>
selected
- xxxxx
cssClass
example
renderNavigationOn:
renderPanelOn:
renderTabsOn:
scriptSelected:on:
selected
selected:
SUTieredList
A SUTieredList is xxxxxxxxx.
Instance Variables
childrenBlock: <Object>
labelBlock: <Object>
selectionPath: <Object>
uid: <Object>
childrenBlock
- xxxxx
labelBlock
- xxxxx
selectionPath
- xxxxx
uid
- xxxxx
children:
Define a one argument block that answers a collection of children for a given node.
example
initialize
Subclasses should redefine this method to perform initializations on instance creation
labels:
Define a one argument block that answers a string for a given node.
renderContentOn:
renderList:level:on:
renderListOn:
selection
Answer the selection path including the root node.
selection:
Set the selection path including the root node.
SUTimedObserver
This is an abstract class which corresponds to the class Abstract.TimedObserver in the prototype.js library.
All of the prototype.js observers watch an element (specified by #id) at a particular #frequency and evaluate a javascript #function if the element has changed. The function takes two arguments, element (the element that changed) and value (the new value).
So the simplest use of an observer looks something like this:
html textInput id: 'watchMe'.
html script: (html formElementObserver
id: 'watchMe';
frequency: 2 seconds;
function: 'alert(value)')
or you can put something more interesting in the function, e.g.:
function: (html updater ... )
defaultArguments
defaultFrequency
defaultFunction
frequency
frequency:
function
function:
initialize
Subclasses should redefine this method to perform initializations on instance creation
SUTimeout
A SUTimeout is xxxxxxxxx.
Instance Variables
duration: <Object>
duration
- xxxxx
duration
duration:
printContentOn:
SUTogglesTest
A SUTogglesTest is xxxxxxxxx.
Instance Variables
renderContentOn:
toggles
SUTreeReport
A SUTreeReport is xxxxxxxxx.
Instance Variables
childrenBlock: <Object>
columns: <Object>
expandableBlock: <Object>
expanded: <Object>
roots: <Object>
uids: <Object>
childrenBlock
- xxxxx
columns
- xxxxx
expandableBlock
- xxxxx
expanded
- xxxxx
roots
- xxxxx
uids
- xxxxx
addColumn:label:
children:
collapse:level:on:
expand:level:on:
expandable:
initialize
Subclasses should redefine this method to perform initializations on instance creation
recursiveCollapse:on:
renderBodyOn:
Render the body of the tree report.
renderContentOn:
renderHeadOn:
Display the column titles of the tree report.
renderRow:level:on:
Render a specific row anObject at level anInteger.
renderRowIndent:level:on:
renderRows:level:on:
roots:
toggle:level:on:
uid:on:
SUTreeReportExample
A SUTreeReportExample is xxxxxxxxx.
Instance Variables
treeReport: <Object>
treeReport
- xxxxx
children
This method is really important. It should return a collection of all subcomponents of the current component that will be rendered in #renderContentOn:. Components that are displayed using #call: are *not* children.
If the contents returned by this method change over time make sure to return them in #states as well, otherwise the back button will fail.
initialize
Subclasses should redefine this method to perform initializations on instance creation
SUTreeReportLibrary
A SUTreeReportLibrary is xxxxxxxxx.
Instance Variables
collapsedGif
expandedGif
selectorsToInclude
The files represented by the selectors this method returns will be automatically added to the html <head> if the receiver is added to the respective Seaside application.
This makes only sense for CSS and JS files
treeLibraryCss
SUTreeTest
A SUTreeTest is xxxxxxxxx.
Instance Variables
tree: <Object>
tree
- xxxxx
childrenOf:
initialize
Subclasses should redefine this method to perform initializations on instance creation
renderChildren:on:
renderContentOn:
renderNode:on:
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SUUpdater
Performs an AJAX request and updates a container's contents based on the response text.
defaultArguments
defaultId
defaultPrototype
evalScripts:
This determines whether <script> elements in the response text are evaluated or not. The default implementation of Prototypes does not evaluate script, however this implementation changes this odd behavior.
id
id:
initialize
Subclasses should redefine this method to perform initializations on instance creation
insertion:
By default, Element.update is used, which replaces the whole contents of the container with the response text. You may want to instead insert the response text around existing contents. You just need to pass a valid Insertion object for this, such as Insertion.Bottom.
processOn:
SUUpdaterTest
A SUUpdaterTest is xxxxxxxxx.
Instance Variables
insertions
renderContentOn:
renderElementOn:
style
Returns a CSS stylesheet associated with this component. This stylesheet will be added to <head> section of the html document so it will be global and not scoped.
This is done for all visible components (see class comment of WAComponent for what visible means).
Nice for demos but consider using WAFileLibrary or exernal files instead.
SUWelcomeTest
A SUWelcomeTest is xxxxxxxxx.
Instance Variables
renderContentOn:
showSource
ScriptaculousDolphinInfo
A ScriptaculousDolphinInfo is xxxxxxxxx.
Instance Variables
addonName
packageName
Answer the package name of receiver.
ScriptaculousVWInfo
A ScriptaculousVWInfo is xxxxxxxxx.
Instance Variables
addonName
packageName
With the 'vw' suffix, extensions are not exported.
What is this 'vw' suffix for ?