AjaxSelectionList Class Reference

Inherits er::ajax::AjaxComponent.

Collaboration diagram for AjaxSelectionList:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 AjaxSelectionList (WOContext context)
String containerElementName ()
String containerID ()
String elementName ()
String fieldID ()
WOActionResults handleRequest (WORequest request, WOContext context)
String id ()
Object item ()
NSArray list ()
int selectedIndex ()
Object selection ()
void setItem (Object item)
void setSelection (Object selection)
void setValue (String value)
void sleep ()
boolean synchronizesVariablesWithBindings ()
void takeValuesFromRequest (WORequest request, WOContext context)
String value ()

Protected Member Functions

void addRequiredWebResources (WOResponse res)

Private Attributes

String _id
NSArray _list
String _value


Detailed Description

AjaxSelectionList provides a list component that supports keyboard navigation and component renderers. Externally, the component behaves like a form field, similar to WOPopUpButton except that it uses its component content as the renderer for each item instead of taking a displayString.

The javascript wrapper exposes events of the selection changing, the item being selected (via double-click or the enter key), and an item being deleted (with the delete key).

Author:
mschrag elementName (optional) the type of the list element inside the selection list (ul, ol, table) elementName (optional) the type of element for the wrapper (default to "a" to support tabbing, but presents some styling complexities in IE) list (required) the list to render item (required) bound for each item of the list selection (optional) the current selection mandatory (optional) if false, a null value will be prepended to the list. It is up to your component content to handle the null value to show a "No Selection" value. mandatory defaults to true. Mandatory does not imply any validation, it is the semantic equivalent of noSelectionString when compared to WOPopUpButton. id (optional) the id of the list class (optional) the css class of the list style (optional) the css style of the list name (optional) the form field name onchange (optional) the javascript to execute when the selection changes onselect (optional) the javascript to execute when the user presses enter or double-clicks ondelete (optional) the javascript to execute when backspace or delete is pressed focus (optional) if true, the selection list will be focused containerElementName the container element for this component, which is "a"

Constructor & Destructor Documentation

AjaxSelectionList ( WOContext  context  ) 


Member Function Documentation

void addRequiredWebResources ( WOResponse  res  )  [protected, virtual]

Override this method to append the needed scripts for this component.

Parameters:
res 

Implements AjaxComponent.

String containerElementName (  ) 

String containerID (  ) 

String elementName (  ) 

String fieldID (  ) 

WOActionResults handleRequest ( WORequest  request,
WOContext  context 
) [virtual]

Override this method to return the response for an Ajax request.

Parameters:
request 
context 

Implements AjaxComponent.

String id (  ) 

Object item (  ) 

NSArray list (  ) 

int selectedIndex (  ) 

Object selection (  ) 

void setItem ( Object  item  ) 

void setSelection ( Object  selection  ) 

void setValue ( String  value  ) 

void sleep (  ) 

boolean synchronizesVariablesWithBindings (  ) 

void takeValuesFromRequest ( WORequest  request,
WOContext  context 
)

String value (  ) 


Member Data Documentation

String _id [private]

NSArray _list [private]

String _value [private]


The documentation for this class was generated from the following file:

Generated on Sat May 26 06:42:39 2012 for Project Wonder by  doxygen 1.5.8