org.richfaces.taglib
Class ToggleControlTag

java.lang.Object
  javax.faces.webapp.UIComponentTagBase
      javax.faces.webapp.UIComponentClassicTagBase
          javax.faces.webapp.UIComponentELTag
              org.richfaces.webapp.taglib.UIComponentELTagBase
                  org.ajax4jsf.webapp.taglib.UIComponentTagBase
                      org.richfaces.taglib.ToggleControlTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class ToggleControlTag
extends org.ajax4jsf.webapp.taglib.UIComponentTagBase

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase

bodyContent, pageContext, UNIQUE_ID_PREFIX

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Constructor Summary

ToggleControlTag()

Method Summary

java.lang.String	getComponentType()
java.lang.String	getRendererType()
void	release()
void	setAccesskey(javax.el.ValueExpression __accesskey) Access key that, when pressed, transfers focus to this element Setter for accesskey
void	setAction(javax.el.MethodExpression __action) MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by you, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property Setter for action
void	setActionListener(javax.el.MethodExpression __actionListener) MethodBinding pointing at method accepting an ActionEvent with return type void Setter for actionListener
void	setAjaxSingle(javax.el.ValueExpression __ajaxSingle) Boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only.
void	setBypassUpdates(javax.el.ValueExpression __bypassUpdates) If "true", after process validations phase skip updates of model beans an force render response.
void	setData(javax.el.ValueExpression __data) Serialized (on default with JSON) data passed on the client by a developer on AJAX request.
void	setDir(javax.el.ValueExpression __dir) Direction indication for text that does not inherit directionality.
void	setEventsQueue(javax.el.ValueExpression __eventsQueue) Name of requests queue to avoid send next request before complete other from same event.
void	setFocus(javax.el.ValueExpression __focus) ID of an element to set focus after request is completed on client side Setter for focus
void	setFor(javax.el.ValueExpression __for) String, which contains id (in the format of a UIComponent.findComponent() call) of the target Toggle Panel.
void	setIgnoreDupResponses(javax.el.ValueExpression __ignoreDupResponses) Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already.
void	setImmediate(javax.el.ValueExpression __immediate) True means, that the default ActionListener should be executed immediately (i.e.
void	setLang(javax.el.ValueExpression __lang) Code describing the language used in the generated markup for this component Setter for lang
void	setLimitToList(javax.el.ValueExpression __limitToList) If "true", updates on client side ONLY elements from this 'reRender' property.
void	setOnbeforedomupdate(javax.el.ValueExpression __onbeforedomupdate) The client-side script method to be called before DOM is updated Setter for onbeforedomupdate
void	setOnblur(javax.el.ValueExpression __onblur) The client-side script method to be called when the element loses the focus Setter for onblur
void	setOnclick(javax.el.ValueExpression __onclick) The client-side script method to be called when the element is clicked Setter for onclick
void	setOncomplete(javax.el.ValueExpression __oncomplete) The client-side script method to be called after the request is completed Setter for oncomplete
void	setOndblclick(javax.el.ValueExpression __ondblclick) The client-side script method to be called when the element is double-clicked Setter for ondblclick
void	setOnfocus(javax.el.ValueExpression __onfocus) The client-side script method to be called when the element gets the focus Setter for onfocus
void	setOnkeydown(javax.el.ValueExpression __onkeydown) The client-side script method to be called when a key is pressed down over the element Setter for onkeydown
void	setOnkeypress(javax.el.ValueExpression __onkeypress) The client-side script method to be called when a key is pressed and released over the element Setter for onkeypress
void	setOnkeyup(javax.el.ValueExpression __onkeyup) The client-side script method to be called when a key is released over the element Setter for onkeyup
void	setOnmousedown(javax.el.ValueExpression __onmousedown) The client-side script method to be called when a mouse button is pressed down over the element Setter for onmousedown
void	setOnmousemove(javax.el.ValueExpression __onmousemove) The client-side script method to be called when a pointer is moved within the element Setter for onmousemove
void	setOnmouseout(javax.el.ValueExpression __onmouseout) The client-side script method to be called when a pointer is moved away from the element Setter for onmouseout
void	setOnmouseover(javax.el.ValueExpression __onmouseover) The client-side script method to be called when a pointer is moved onto the element Setter for onmouseover
void	setOnmouseup(javax.el.ValueExpression __onmouseup) The client-side script method to be called when a mouse button is released over the element Setter for onmouseup
void	setProcess(javax.el.ValueExpression __process) Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 in case of AjaxRequest caused by this component.
protected void	setProperties(javax.faces.component.UIComponent component)
void	setRequestDelay(javax.el.ValueExpression __requestDelay) Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send.
void	setReRender(javax.el.ValueExpression __reRender) Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component.
void	setSimilarityGroupingId(javax.el.ValueExpression __similarityGroupingId) If there are any component requests with identical IDs then these requests will be grouped.
void	setStatus(javax.el.ValueExpression __status) ID (in format of call UIComponent.findComponent()) of Request status component Setter for status
void	setStyle(javax.el.ValueExpression __style) CSS style rules to be applied to the component Setter for style
void	setStyleClass(javax.el.ValueExpression __styleClass) Assigns one or more space-separated CSS class names to the component.
void	setSwitchToState(javax.el.ValueExpression __switchToState) Contains one of the facets names where target togglePanel is switched to Setter for switchToState
void	setTabindex(javax.el.ValueExpression __tabindex) Position of this element in the tabbing order for the current document.
void	setTimeout(javax.el.ValueExpression __timeout) Response waiting time on a particular request.
void	setTitle(javax.el.ValueExpression __title) Advisory title information about markup elements generated for this component Setter for title
void	setValue(javax.el.ValueExpression __value) Initial value to set when rendered for the first time Setter for value

Methods inherited from class org.ajax4jsf.webapp.taglib.UIComponentTagBase

getExpressionFactory, isValueReference, setActionListenerProperty, setActionProperty, setBooleanProperty, setBooleanProperty, setDoubleProperty, setDoubleProperty, setFloatProperty, setFloatProperty, setIntegerProperty, setIntegerProperty, setLongProperty, setLongProperty, setProperty, setProperty, setStringProperty, setStringProperty, setValueChangedListenerProperty, setValueProperty, setValueProperty

Methods inherited from class org.richfaces.webapp.taglib.UIComponentELTagBase

setActionListenerProperty, setActionProperty, setConverterProperty, setRowKeyConverterProperty, setValidatorProperty, setValueChangeListenerProperty

Methods inherited from class javax.faces.webapp.UIComponentELTag

createComponent, getELContext, hasBinding, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, setPageContext, setParent

Constructor Detail

ToggleControlTag

public ToggleControlTag()

Method Detail

setAccesskey

public void setAccesskey(javax.el.ValueExpression __accesskey)

Access key that, when pressed, transfers focus to this element Setter for accesskey

Parameters:

accesskey - - new value

setAction

public void setAction(javax.el.MethodExpression __action)

MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by you, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property Setter for action

Parameters:

action - - new value

setActionListener

public void setActionListener(javax.el.MethodExpression __actionListener)

MethodBinding pointing at method accepting an ActionEvent with return type void Setter for actionListener

Parameters:

actionListener - - new value

setAjaxSingle

public void setAjaxSingle(javax.el.ValueExpression __ajaxSingle)

Boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only. Default value is "false". Setter for ajaxSingle

Parameters:

ajaxSingle - - new value

setBypassUpdates

public void setBypassUpdates(javax.el.ValueExpression __bypassUpdates)

If "true", after process validations phase skip updates of model beans an force render response. Can be used for validate components input Setter for bypassUpdates

Parameters:

bypassUpdates - - new value

setData

public void setData(javax.el.ValueExpression __data)

Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax Setter for data

Parameters:

data - - new value

setDir

public void setDir(javax.el.ValueExpression __dir)

Direction indication for text that does not inherit directionality. Possible values are "LTR" (left-to-right) and "RTL" (right-to-left). Setter for dir

Parameters:

dir - - new value

setEventsQueue

public void setEventsQueue(javax.el.ValueExpression __eventsQueue)

Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move, etc.) Setter for eventsQueue

Parameters:

eventsQueue - - new value

setFocus

public void setFocus(javax.el.ValueExpression __focus)

ID of an element to set focus after request is completed on client side Setter for focus

Parameters:

focus - - new value

setFor

public void setFor(javax.el.ValueExpression __for)

String, which contains id (in the format of a UIComponent.findComponent() call) of the target Toggle Panel. Setter for for

Parameters:

for - - new value

setIgnoreDupResponses

public void setIgnoreDupResponses(javax.el.ValueExpression __ignoreDupResponses)

Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now Setter for ignoreDupResponses

Parameters:

ignoreDupResponses - - new value

setImmediate

public void setImmediate(javax.el.ValueExpression __immediate)

True means, that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase Setter for immediate

Parameters:

immediate - - new value

setLang

public void setLang(javax.el.ValueExpression __lang)

Code describing the language used in the generated markup for this component Setter for lang

Parameters:

lang - - new value

setLimitToList

public void setLimitToList(javax.el.ValueExpression __limitToList)

If "true", updates on client side ONLY elements from this 'reRender' property. if "false" (default) updates all rendered by ajax region components Setter for limitToList

Parameters:

limitToList - - new value

setOnbeforedomupdate

public void setOnbeforedomupdate(javax.el.ValueExpression __onbeforedomupdate)

The client-side script method to be called before DOM is updated Setter for onbeforedomupdate

Parameters:

onbeforedomupdate - - new value

setOnblur

public void setOnblur(javax.el.ValueExpression __onblur)

The client-side script method to be called when the element loses the focus Setter for onblur

Parameters:

onblur - - new value

setOnclick

public void setOnclick(javax.el.ValueExpression __onclick)

The client-side script method to be called when the element is clicked Setter for onclick

Parameters:

onclick - - new value

setOncomplete

public void setOncomplete(javax.el.ValueExpression __oncomplete)

The client-side script method to be called after the request is completed Setter for oncomplete

Parameters:

oncomplete - - new value

setOndblclick

public void setOndblclick(javax.el.ValueExpression __ondblclick)

The client-side script method to be called when the element is double-clicked Setter for ondblclick

Parameters:

ondblclick - - new value

setOnfocus

public void setOnfocus(javax.el.ValueExpression __onfocus)

The client-side script method to be called when the element gets the focus Setter for onfocus

Parameters:

onfocus - - new value

setOnkeydown

public void setOnkeydown(javax.el.ValueExpression __onkeydown)

The client-side script method to be called when a key is pressed down over the element Setter for onkeydown

Parameters:

onkeydown - - new value

setOnkeypress

public void setOnkeypress(javax.el.ValueExpression __onkeypress)

The client-side script method to be called when a key is pressed and released over the element Setter for onkeypress

Parameters:

onkeypress - - new value

setOnkeyup

public void setOnkeyup(javax.el.ValueExpression __onkeyup)

The client-side script method to be called when a key is released over the element Setter for onkeyup

Parameters:

onkeyup - - new value

setOnmousedown

public void setOnmousedown(javax.el.ValueExpression __onmousedown)

The client-side script method to be called when a mouse button is pressed down over the element Setter for onmousedown

Parameters:

onmousedown - - new value

setOnmousemove

public void setOnmousemove(javax.el.ValueExpression __onmousemove)

The client-side script method to be called when a pointer is moved within the element Setter for onmousemove

Parameters:

onmousemove - - new value

setOnmouseout

public void setOnmouseout(javax.el.ValueExpression __onmouseout)

The client-side script method to be called when a pointer is moved away from the element Setter for onmouseout

Parameters:

onmouseout - - new value

setOnmouseover

public void setOnmouseover(javax.el.ValueExpression __onmouseover)

The client-side script method to be called when a pointer is moved onto the element Setter for onmouseover

Parameters:

onmouseover - - new value

setOnmouseup

public void setOnmouseup(javax.el.ValueExpression __onmouseup)

The client-side script method to be called when a mouse button is released over the element Setter for onmouseup

Parameters:

onmouseup - - new value

setProcess

public void setProcess(javax.el.ValueExpression __process)

Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection Setter for process

Parameters:

process - - new value

setReRender

public void setReRender(javax.el.ValueExpression __reRender)

Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection Setter for reRender

Parameters:

reRender - - new value

setRequestDelay

public void setRequestDelay(javax.el.ValueExpression __requestDelay)

Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. When the delay time is over, the request will be sent to the server or removed if the newest 'similar' request is in a queue already Setter for requestDelay

Parameters:

requestDelay - - new value

setSimilarityGroupingId

public void setSimilarityGroupingId(javax.el.ValueExpression __similarityGroupingId)

If there are any component requests with identical IDs then these requests will be grouped. Setter for similarityGroupingId

Parameters:

similarityGroupingId - - new value

setStatus

public void setStatus(javax.el.ValueExpression __status)

ID (in format of call UIComponent.findComponent()) of Request status component Setter for status

Parameters:

status - - new value

setStyle

public void setStyle(javax.el.ValueExpression __style)

CSS style rules to be applied to the component Setter for style

Parameters:

style - - new value

setStyleClass

public void setStyleClass(javax.el.ValueExpression __styleClass)

Assigns one or more space-separated CSS class names to the component. Corresponds to the HTML "class" attribute. Setter for styleClass

Parameters:

styleClass - - new value

setSwitchToState

public void setSwitchToState(javax.el.ValueExpression __switchToState)

Contains one of the facets names where target togglePanel is switched to Setter for switchToState

Parameters:

switchToState - - new value

setTabindex

public void setTabindex(javax.el.ValueExpression __tabindex)

Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767 Setter for tabindex

Parameters:

tabindex - - new value

setTimeout

public void setTimeout(javax.el.ValueExpression __timeout)

Response waiting time on a particular request. If a response is not received during this time, the request is aborted Setter for timeout

Parameters:

timeout - - new value

setTitle

public void setTitle(javax.el.ValueExpression __title)

Advisory title information about markup elements generated for this component Setter for title

Parameters:

title - - new value

setValue

public void setValue(javax.el.ValueExpression __value)

Initial value to set when rendered for the first time Setter for value

Parameters:

value - - new value

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.faces.webapp.UIComponentELTag

setProperties

protected void setProperties(javax.faces.component.UIComponent component)

Overrides:

setProperties in class javax.faces.webapp.UIComponentELTag

getComponentType

public java.lang.String getComponentType()

Specified by:

getComponentType in class javax.faces.webapp.UIComponentTagBase

getRendererType

public java.lang.String getRendererType()

Specified by:

getRendererType in class javax.faces.webapp.UIComponentTagBase