AjaxTabbedPanelTab Class Reference

Inherits er::ajax::AjaxDynamicElement.

Collaboration diagram for AjaxTabbedPanelTab:

Collaboration graph
[legend]

List of all members.

Public Member Functions

WOAssociation accesskey ()
 AjaxTabbedPanelTab (String aName, NSDictionary associations, WOElement template)
void appendToResponse (WOResponse aResponse, WOContext aContext)
WOActionResults handleRequest (WORequest request, WOContext context)
WOAssociation id ()
WOActionResults invokeAction (WORequest request, WOContext context)
boolean isSelected (WOComponent component)
boolean isVisble (WOComponent component)
WOAssociation name ()
Boolean refreshesOnSelect (WOComponent component)
void setId (WOAssociation newID)
void setIsSelected (WOComponent component, boolean isTabSelected)
void takeValuesFromRequest (WORequest request, WOContext context)

Protected Member Functions

String _containerID (WOContext context)
void addRequiredWebResources (WOResponse response, WOContext context)

Private Attributes

WOAssociation accesskey
WOElement content
WOAssociation id
WOAssociation isSelected
WOAssociation isVisible
WOAssociation name
WOAssociation onLoad
WOAssociation refreshOnSelect


Detailed Description

This implements the tab contents of a tabbed panel display as an unordered list (UL and LI elements). This is to be used inside of a AjaxTabbedPanel. The contents can be anything.

See also:
er.ajax.AjaxTabbedPanel for details on CSS and usage
name required, String the text shown in the tab that is clicked on to select the tab isSelected optional, boolean true if this tab is initially selected when the page is first rendered, defaults to false. If present and can be set, is set to true when this tab is selected and to false when it is no longer the selected tab id optional, String the id attribute of the A element selecting this panel, [id]_panel is the id of LI element implementing this tab refreshOnSelect optional, if true the tab content will reload each time the tab is selected. Defaults to false onLoad optional, String JavaScript to execute after the tab loads isVisible optional, default is true, indicates if tab and panel should be displayed accesskey optional, The accesskey for this tab

Author:
Chuck Hill

Constructor & Destructor Documentation

AjaxTabbedPanelTab ( String  aName,
NSDictionary  associations,
WOElement  template 
)


Member Function Documentation

String _containerID ( WOContext  context  )  [protected]

Parameters:
context WOContext response is being returned in
Returns:
ID to cache this Ajax response under

Reimplemented from AjaxDynamicElement.

WOAssociation accesskey (  ) 

Returns:
WOAssociation for the accesskey binding

void addRequiredWebResources ( WOResponse  response,
WOContext  context 
) [protected, virtual]

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

Implements AjaxDynamicElement.

void appendToResponse ( WOResponse  aResponse,
WOContext  aContext 
)

Creates the panes.

Reimplemented from AjaxDynamicElement.

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

The pane content is rendered when an Ajax request is received.

Returns:
the children rendered as HTML

Implements AjaxDynamicElement.

WOAssociation id (  ) 

Returns:
association for HTML id attribute

WOActionResults invokeAction ( WORequest  request,
WOContext  context 
)

Do nothing if not visible.

Reimplemented from AjaxDynamicElement.

boolean isSelected ( WOComponent  component  ) 

Parameters:
component the component this is being rendered in
Returns:
true if this pane is the selected one

boolean isVisble ( WOComponent  component  ) 

Returns current component's value for the isVisible binding.

Parameters:
component the component this is being rendered in
Returns:
Boolean value for isVisible binding, Boolean.TRUE if unset

WOAssociation name (  ) 

Returns:
association for HTML id attribute.

Boolean refreshesOnSelect ( WOComponent  component  ) 

Returns current component's value for the refreshOnSelect binding.

Parameters:
component the component this is being rendered in
Returns:
Boolean value for refreshOnSelect binding, Boolean.FALSE if unset

void setId ( WOAssociation  newID  ) 

Sets the id association so that the AjaxTabbedPanel can provide an id if needed.

Parameters:
newID the association to use to get the HTML id attribute

void setIsSelected ( WOComponent  component,
boolean  isTabSelected 
)

If present and settable, sets the isSelected association to true for this tab when it selected and to false when it is no longer the selected tab.

Parameters:
component the component this is being rendered in
isTabSelected true is this is being rendered as the selected tab

void takeValuesFromRequest ( WORequest  request,
WOContext  context 
)

Do nothing if not visible.

Reimplemented from AjaxDynamicElement.


Member Data Documentation

WOAssociation accesskey [private]

WOElement content [private]

WOAssociation id [private]

WOAssociation isSelected [private]

WOAssociation isVisible [private]

WOAssociation name [private]

WOAssociation onLoad [private]

WOAssociation refreshOnSelect [private]


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

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