er.ajax

Class AjaxTabbedPanelTab

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

er.extensions.components.ERXDynamicElement

er.ajax.AjaxDynamicElement

er.ajax.AjaxTabbedPanelTab

All Implemented Interfaces:

IAjaxElement

public class AjaxTabbedPanelTab
extends AjaxDynamicElement

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:

for details on CSS and usage

Author:

Chuck Hill

Bindings

Name	Description
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

Nested Class Summary

Nested classes/interfaces inherited from class er.extensions.components.ERXDynamicElement

ERXDynamicElement.ContextData<T>

Field Summary

Fields inherited from class er.extensions.components.ERXDynamicElement

log

Fields inherited from class com.webobjects.appserver._private.WODynamicGroup

_children

Fields inherited from class com.webobjects.appserver.WODynamicElement

_ConstructorParameters

Constructor Summary

Constructors

Constructor and Description
AjaxTabbedPanelTab(String aName, NSDictionary associations, WOElement template)

Method Summary

Modifier and Type	Method and Description
protected String	_containerID(WOContext context) Override this method and return an update container ID this element should react on.
WOAssociation	accesskey()
protected void	addRequiredWebResources(WOResponse response, WOContext context) Override this method to append the needed scripts for this component.
void	appendToResponse(WOResponse aResponse, WOContext aContext) Creates the panes.
WOActionResults	handleRequest(WORequest request, WOContext context) The pane content is rendered when an Ajax request is received.
WOAssociation	id()
WOActionResults	invokeAction(WORequest request, WOContext context) Do nothing if not visible.
boolean	isSelected(WOComponent component)
boolean	isVisble(WOComponent component) Returns current component's value for the isVisible binding.
WOAssociation	name()
WOAssociation	parentId()
Boolean	refreshesOnSelect(WOComponent component) Returns current component's value for the refreshOnSelect binding.
void	setId(WOAssociation newID) Sets the id association so that the AjaxTabbedPanel can provide an id if needed.
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.
void	setParentId(WOAssociation aParentId)
void	setTabNumber(WOAssociation aTabNumber)
String	tabIdInComponent(WOComponent component) If the id binding is set, then this is used for the id, otherwise the parentId and tabNumber bindings are combined to make an id.
WOAssociation	tabNumber()
void	takeValuesFromRequest(WORequest request, WOContext context) Do nothing if not visible.

Methods inherited from class er.ajax.AjaxDynamicElement

addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, shouldHandleRequest

Methods inherited from class er.extensions.components.ERXDynamicElement

afterProcessing, appendTagAttributeToResponse, arrayValueForBinding, arrayValueForBinding, associations, beforeProcessing, bindingIsSettable, bindingNamed, booleanValueForBinding, booleanValueForBinding, hasBinding, id, integerValueForBinding, nameInContext, secureInContext, setValueForBinding, stringValueForBinding, stringValueForBinding, valueForBinding, valueForBinding

Methods inherited from class com.webobjects.appserver._private.WODynamicGroup

addChildElement, appendChildrenToResponse, childrenElements, EmptyGroup, hasChildrenElements, invokeChildrenAction, takeChildrenValuesFromRequest, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface er.ajax.IAjaxElement

valueForBinding, valueForBinding

Constructor Detail

AjaxTabbedPanelTab

public AjaxTabbedPanelTab(String aName,
                          NSDictionary associations,
                          WOElement template)

Method Detail

appendToResponse

public void appendToResponse(WOResponse aResponse,
                             WOContext aContext)

Creates the panes.

Overrides:

appendToResponse in class AjaxDynamicElement

Parameters:

aResponse - the current response

aContext - context of the transaction

takeValuesFromRequest

public void takeValuesFromRequest(WORequest request,
                                  WOContext context)

Do nothing if not visible.

Overrides:

takeValuesFromRequest in class com.webobjects.appserver._private.WODynamicGroup

invokeAction

public WOActionResults invokeAction(WORequest request,
                                    WOContext context)

Do nothing if not visible.

Overrides:

invokeAction in class AjaxDynamicElement

Parameters:

request - the current request

context - context of the transaction

Returns:

the action results

isSelected

public boolean isSelected(WOComponent component)

Parameters:

component - the component this is being rendered in

Returns:

true if this pane is the selected one

setIsSelected

public 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

addRequiredWebResources

protected void addRequiredWebResources(WOResponse response,
                                       WOContext context)

Description copied from class: AjaxDynamicElement

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

Specified by:

addRequiredWebResources in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction

handleRequest

public WOActionResults handleRequest(WORequest request,
                                     WOContext context)

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

Specified by:

handleRequest in interface IAjaxElement

Specified by:

handleRequest in class AjaxDynamicElement

Parameters:

request - the current request

context - context of the transaction

Returns:

the children rendered as HTML

_containerID

protected String _containerID(WOContext context)

Description copied from class: AjaxDynamicElement

Override this method and return an update container ID this element should react on.

Overrides:

_containerID in class AjaxDynamicElement

Parameters:

context - WOContext response is being returned in

Returns:

ID to cache this Ajax response under

tabIdInComponent

public String tabIdInComponent(WOComponent component)

If the id binding is set, then this is used for the id, otherwise the parentId and tabNumber bindings are combined to make an id.

Parameters:

component - for value lookups

Returns:

id of this tab

id

public WOAssociation id()

Returns:

association for HTML id attribute

setId

public 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

name

public WOAssociation name()

Returns:

association for HTML id attribute.

refreshesOnSelect

public 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

isVisble

public 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

accesskey

public WOAssociation accesskey()

Returns:

WOAssociation for the accesskey binding

setParentId

public void setParentId(WOAssociation aParentId)

parentId

public WOAssociation parentId()

setTabNumber

public void setTabNumber(WOAssociation aTabNumber)

tabNumber

public WOAssociation tabNumber()