org.richfaces.component.html
Class HtmlSimpleTogglePanel

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by org.ajax4jsf.component.AjaxActionComponent
                  extended by org.richfaces.component.UISimpleTogglePanel
                      extended by org.richfaces.component.html.HtmlSimpleTogglePanel
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.StateHolder, org.ajax4jsf.component.AjaxComponent, org.ajax4jsf.event.AjaxSource

public class HtmlSimpleTogglePanel
extends UISimpleTogglePanel

Component-Type org.richfaces.SimpleTogglePanel Component-Family org.richfaces.SimpleTogglePanel Renderer-Type org.richfaces.SimpleTogglePanelRenderer Wrapper component with named facets. Every facet will be shown after activation corresponding toggleControl(the other will be hidden).


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class org.richfaces.component.UISimpleTogglePanel
AJAX_SWITCH_TYPE, CLIENT_SWITCH_TYPE, COLLAPSED, EXPANDED, SERVER_SWITCH_TYPE
 
Fields inherited from class org.ajax4jsf.component.AjaxActionComponent
FOCUS_DATA_ID
 
Fields inherited from interface org.ajax4jsf.component.AjaxComponent
AJAX_COMPONETT_PARAMETER
 
Constructor Summary
HtmlSimpleTogglePanel()
          Constructor to init default renderers
 
Method Summary
 java.lang.String getBodyClass()
          A class that defines a style for a panel content Getter for bodyClass
 java.lang.Object getData()
          Serialized (on default with JSON) data passed on the client by a developer on AJAX request.
 java.lang.String getEventsQueue()
          Name of requests queue to avoid send next request before complete other from same event.
 java.lang.String getFamily()
           
 java.lang.String getFocus()
          id of element to set focus after request completed on client side Getter for focus
 java.lang.String getHeaderClass()
          Class that defines the style for panel header Getter for headerClass
 java.lang.String getHeight()
          Height of a simple toggle panel content area might be defined as pixels or in percents.
 java.lang.String getLabel()
          Marker to be rendered on a panel header Getter for label
 java.lang.String getOnbeforedomupdate()
          JavaScript code for call before DOM has been updated on client side Getter for onbeforedomupdate
 java.lang.String getOnclick()
          HTML: a script expression; a pointer button is clicked Getter for onclick
 java.lang.String getOncomplete()
          JavaScript code for call after request completed on client side Getter for oncomplete
 java.lang.String getOndblclick()
          HTML: a script expression; a pointer button is double-clicked Getter for ondblclick
 java.lang.String getOnkeydown()
          HTML: a script expression; a key is pressed down Getter for onkeydown
 java.lang.String getOnkeypress()
          HTML: a script expression; a key is pressed and released Getter for onkeypress
 java.lang.String getOnkeyup()
          HTML: a script expression; a key is released Getter for onkeyup
 java.lang.String getOnmousedown()
          HTML: script expression; a pointer button is pressed down Getter for onmousedown
 java.lang.String getOnmousemove()
          HTML: a script expression; a pointer is moved within Getter for onmousemove
 java.lang.String getOnmouseout()
          HTML: a script expression; a pointer is moved away Getter for onmouseout
 java.lang.String getOnmouseover()
          HTML: a script expression; a pointer is moved onto Getter for onmouseover
 java.lang.String getOnmouseup()
          HTML: script expression; a pointer button is released Getter for onmouseup
 int getRequestDelay()
          Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send.
 java.lang.Object getReRender()
          Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component.
 java.lang.String getStatus()
          ID (in format of call UIComponent.findComponent()) of Request status component Getter for status
 java.lang.String getStyle()
          CSS style(s) is/are to be applied when this component is rendered Getter for style
 java.lang.String getStyleClass()
          Corresponds to the HTML class attribute Getter for styleClass
 java.lang.String getSwitchType()
          Facets switch algorithm: "client", "server"(default), "ajax" Getter for switchType
 int getTimeout()
          Response waiting time on a particular request.
 java.lang.String getWidth()
          Width of a simple toggle panel might be defined as pixels or in percents.
 boolean isAjaxSingle()
          if "true", submits ONLY one field/link, instead of all form controls Getter for ajaxSingle
 boolean isBypassUpdates()
          If "true", after process validations phase it skips updates of model beans on a force render response.
 boolean isIgnoreDupResponses()
          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 Getter for ignoreDupResponses
 boolean isLimitToList()
          If "true", updates on client side ONLY elements from this 'reRender' property.
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setAjaxSingle(boolean __ajaxSingle)
          if "true", submits ONLY one field/link, instead of all form controls Setter for ajaxSingle
 void setBodyClass(java.lang.String __bodyClass)
          A class that defines a style for a panel content Setter for bodyClass
 void setBypassUpdates(boolean __bypassUpdates)
          If "true", after process validations phase it skips updates of model beans on a force render response.
 void setData(java.lang.Object __data)
          Serialized (on default with JSON) data passed on the client by a developer on AJAX request.
 void setEventsQueue(java.lang.String __eventsQueue)
          Name of requests queue to avoid send next request before complete other from same event.
 void setFocus(java.lang.String __focus)
          id of element to set focus after request completed on client side Setter for focus
 void setHeaderClass(java.lang.String __headerClass)
          Class that defines the style for panel header Setter for headerClass
 void setHeight(java.lang.String __height)
          Height of a simple toggle panel content area might be defined as pixels or in percents.
 void setIgnoreDupResponses(boolean __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
 void setLabel(java.lang.String __label)
          Marker to be rendered on a panel header Setter for label
 void setLimitToList(boolean __limitToList)
          If "true", updates on client side ONLY elements from this 'reRender' property.
 void setOnbeforedomupdate(java.lang.String __onbeforedomupdate)
          JavaScript code for call before DOM has been updated on client side Setter for onbeforedomupdate
 void setOnclick(java.lang.String __onclick)
          HTML: a script expression; a pointer button is clicked Setter for onclick
 void setOncomplete(java.lang.String __oncomplete)
          JavaScript code for call after request completed on client side Setter for oncomplete
 void setOndblclick(java.lang.String __ondblclick)
          HTML: a script expression; a pointer button is double-clicked Setter for ondblclick
 void setOnkeydown(java.lang.String __onkeydown)
          HTML: a script expression; a key is pressed down Setter for onkeydown
 void setOnkeypress(java.lang.String __onkeypress)
          HTML: a script expression; a key is pressed and released Setter for onkeypress
 void setOnkeyup(java.lang.String __onkeyup)
          HTML: a script expression; a key is released Setter for onkeyup
 void setOnmousedown(java.lang.String __onmousedown)
          HTML: script expression; a pointer button is pressed down Setter for onmousedown
 void setOnmousemove(java.lang.String __onmousemove)
          HTML: a script expression; a pointer is moved within Setter for onmousemove
 void setOnmouseout(java.lang.String __onmouseout)
          HTML: a script expression; a pointer is moved away Setter for onmouseout
 void setOnmouseover(java.lang.String __onmouseover)
          HTML: a script expression; a pointer is moved onto Setter for onmouseover
 void setOnmouseup(java.lang.String __onmouseup)
          HTML: script expression; a pointer button is released Setter for onmouseup
 void setRequestDelay(int __requestDelay)
          Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send.
 void setReRender(java.lang.Object __reRender)
          Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component.
 void setStatus(java.lang.String __status)
          ID (in format of call UIComponent.findComponent()) of Request status component Setter for status
 void setStyle(java.lang.String __style)
          CSS style(s) is/are to be applied when this component is rendered Setter for style
 void setStyleClass(java.lang.String __styleClass)
          Corresponds to the HTML class attribute Setter for styleClass
 void setSwitchType(java.lang.String __switchType)
          Facets switch algorithm: "client", "server"(default), "ajax" Setter for switchType
 void setTimeout(int __timeout)
          Response waiting time on a particular request.
 void setWidth(java.lang.String __width)
          Width of a simple toggle panel might be defined as pixels or in percents.
 
Methods inherited from class org.richfaces.component.UISimpleTogglePanel
getRendersChildren, isOpened, setOpened
 
Methods inherited from class org.ajax4jsf.component.AjaxActionComponent
addAjaxListener, broadcast, getAjaxListeners, getSingleComponent, queueEvent, removeAjaxListener, setupReRender, setupReRender
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getAction, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.ajax4jsf.event.AjaxSource
addAjaxListener, getAjaxListeners, removeAjaxListener
 
Methods inherited from interface javax.faces.component.ActionSource
addActionListener, getAction, getActionListener, getActionListeners, isImmediate, removeActionListener, setAction, setActionListener, setImmediate
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

HtmlSimpleTogglePanel

public HtmlSimpleTogglePanel()
Constructor to init default renderers

Method Detail

setAjaxSingle

public void setAjaxSingle(boolean __ajaxSingle)
if "true", submits ONLY one field/link, instead of all form controls Setter for ajaxSingle

Parameters:
ajaxSingle - - new value

isAjaxSingle

public boolean isAjaxSingle()
if "true", submits ONLY one field/link, instead of all form controls Getter for ajaxSingle

Returns:
ajaxSingle value from local variable or value bindings

setBodyClass

public void setBodyClass(java.lang.String __bodyClass)
A class that defines a style for a panel content Setter for bodyClass

Parameters:
bodyClass - - new value

getBodyClass

public java.lang.String getBodyClass()
A class that defines a style for a panel content Getter for bodyClass

Returns:
bodyClass value from local variable or value bindings

setBypassUpdates

public void setBypassUpdates(boolean __bypassUpdates)
If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input Setter for bypassUpdates

Parameters:
bypassUpdates - - new value

isBypassUpdates

public boolean isBypassUpdates()
If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input Getter for bypassUpdates

Returns:
bypassUpdates value from local variable or value bindings

setData

public void setData(java.lang.Object __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

getData

public java.lang.Object getData()
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax Getter for data

Returns:
data value from local variable or value bindings

setEventsQueue

public void setEventsQueue(java.lang.String __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

getEventsQueue

public java.lang.String getEventsQueue()
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.) Getter for eventsQueue

Returns:
eventsQueue value from local variable or value bindings

setFocus

public void setFocus(java.lang.String __focus)
id of element to set focus after request completed on client side Setter for focus

Parameters:
focus - - new value

getFocus

public java.lang.String getFocus()
id of element to set focus after request completed on client side Getter for focus

Returns:
focus value from local variable or value bindings

setHeaderClass

public void setHeaderClass(java.lang.String __headerClass)
Class that defines the style for panel header Setter for headerClass

Parameters:
headerClass - - new value

getHeaderClass

public java.lang.String getHeaderClass()
Class that defines the style for panel header Getter for headerClass

Returns:
headerClass value from local variable or value bindings

setHeight

public void setHeight(java.lang.String __height)
Height of a simple toggle panel content area might be defined as pixels or in percents. By default height is not defined Setter for height

Parameters:
height - - new value

getHeight

public java.lang.String getHeight()
Height of a simple toggle panel content area might be defined as pixels or in percents. By default height is not defined Getter for height

Returns:
height value from local variable or value bindings

setIgnoreDupResponses

public void setIgnoreDupResponses(boolean __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

isIgnoreDupResponses

public boolean isIgnoreDupResponses()
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 Getter for ignoreDupResponses

Returns:
ignoreDupResponses value from local variable or value bindings

setLabel

public void setLabel(java.lang.String __label)
Marker to be rendered on a panel header Setter for label

Parameters:
label - - new value

getLabel

public java.lang.String getLabel()
Marker to be rendered on a panel header Getter for label

Returns:
label value from local variable or value bindings

setLimitToList

public void setLimitToList(boolean __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

isLimitToList

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

Returns:
limitToList value from local variable or value bindings

setOnbeforedomupdate

public void setOnbeforedomupdate(java.lang.String __onbeforedomupdate)
JavaScript code for call before DOM has been updated on client side Setter for onbeforedomupdate

Parameters:
onbeforedomupdate - - new value

getOnbeforedomupdate

public java.lang.String getOnbeforedomupdate()
JavaScript code for call before DOM has been updated on client side Getter for onbeforedomupdate

Returns:
onbeforedomupdate value from local variable or value bindings

setOnclick

public void setOnclick(java.lang.String __onclick)
HTML: a script expression; a pointer button is clicked Setter for onclick

Parameters:
onclick - - new value

getOnclick

public java.lang.String getOnclick()
HTML: a script expression; a pointer button is clicked Getter for onclick

Returns:
onclick value from local variable or value bindings

setOncomplete

public void setOncomplete(java.lang.String __oncomplete)
JavaScript code for call after request completed on client side Setter for oncomplete

Parameters:
oncomplete - - new value

getOncomplete

public java.lang.String getOncomplete()
JavaScript code for call after request completed on client side Getter for oncomplete

Returns:
oncomplete value from local variable or value bindings

setOndblclick

public void setOndblclick(java.lang.String __ondblclick)
HTML: a script expression; a pointer button is double-clicked Setter for ondblclick

Parameters:
ondblclick - - new value

getOndblclick

public java.lang.String getOndblclick()
HTML: a script expression; a pointer button is double-clicked Getter for ondblclick

Returns:
ondblclick value from local variable or value bindings

setOnkeydown

public void setOnkeydown(java.lang.String __onkeydown)
HTML: a script expression; a key is pressed down Setter for onkeydown

Parameters:
onkeydown - - new value

getOnkeydown

public java.lang.String getOnkeydown()
HTML: a script expression; a key is pressed down Getter for onkeydown

Returns:
onkeydown value from local variable or value bindings

setOnkeypress

public void setOnkeypress(java.lang.String __onkeypress)
HTML: a script expression; a key is pressed and released Setter for onkeypress

Parameters:
onkeypress - - new value

getOnkeypress

public java.lang.String getOnkeypress()
HTML: a script expression; a key is pressed and released Getter for onkeypress

Returns:
onkeypress value from local variable or value bindings

setOnkeyup

public void setOnkeyup(java.lang.String __onkeyup)
HTML: a script expression; a key is released Setter for onkeyup

Parameters:
onkeyup - - new value

getOnkeyup

public java.lang.String getOnkeyup()
HTML: a script expression; a key is released Getter for onkeyup

Returns:
onkeyup value from local variable or value bindings

setOnmousedown

public void setOnmousedown(java.lang.String __onmousedown)
HTML: script expression; a pointer button is pressed down Setter for onmousedown

Parameters:
onmousedown - - new value

getOnmousedown

public java.lang.String getOnmousedown()
HTML: script expression; a pointer button is pressed down Getter for onmousedown

Returns:
onmousedown value from local variable or value bindings

setOnmousemove

public void setOnmousemove(java.lang.String __onmousemove)
HTML: a script expression; a pointer is moved within Setter for onmousemove

Parameters:
onmousemove - - new value

getOnmousemove

public java.lang.String getOnmousemove()
HTML: a script expression; a pointer is moved within Getter for onmousemove

Returns:
onmousemove value from local variable or value bindings

setOnmouseout

public void setOnmouseout(java.lang.String __onmouseout)
HTML: a script expression; a pointer is moved away Setter for onmouseout

Parameters:
onmouseout - - new value

getOnmouseout

public java.lang.String getOnmouseout()
HTML: a script expression; a pointer is moved away Getter for onmouseout

Returns:
onmouseout value from local variable or value bindings

setOnmouseover

public void setOnmouseover(java.lang.String __onmouseover)
HTML: a script expression; a pointer is moved onto Setter for onmouseover

Parameters:
onmouseover - - new value

getOnmouseover

public java.lang.String getOnmouseover()
HTML: a script expression; a pointer is moved onto Getter for onmouseover

Returns:
onmouseover value from local variable or value bindings

setOnmouseup

public void setOnmouseup(java.lang.String __onmouseup)
HTML: script expression; a pointer button is released Setter for onmouseup

Parameters:
onmouseup - - new value

getOnmouseup

public java.lang.String getOnmouseup()
HTML: script expression; a pointer button is released Getter for onmouseup

Returns:
onmouseup value from local variable or value bindings

setReRender

public void setReRender(java.lang.Object __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

getReRender

public java.lang.Object getReRender()
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 Getter for reRender

Returns:
reRender value from local variable or value bindings

setRequestDelay

public void setRequestDelay(int __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

getRequestDelay

public int getRequestDelay()
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 Getter for requestDelay

Returns:
requestDelay value from local variable or value bindings

setStatus

public void setStatus(java.lang.String __status)
ID (in format of call UIComponent.findComponent()) of Request status component Setter for status

Parameters:
status - - new value

getStatus

public java.lang.String getStatus()
ID (in format of call UIComponent.findComponent()) of Request status component Getter for status

Returns:
status value from local variable or value bindings

setStyle

public void setStyle(java.lang.String __style)
CSS style(s) is/are to be applied when this component is rendered Setter for style

Parameters:
style - - new value

getStyle

public java.lang.String getStyle()
CSS style(s) is/are to be applied when this component is rendered Getter for style

Returns:
style value from local variable or value bindings

setStyleClass

public void setStyleClass(java.lang.String __styleClass)
Corresponds to the HTML class attribute Setter for styleClass

Parameters:
styleClass - - new value

getStyleClass

public java.lang.String getStyleClass()
Corresponds to the HTML class attribute Getter for styleClass

Returns:
styleClass value from local variable or value bindings

setSwitchType

public void setSwitchType(java.lang.String __switchType)
Facets switch algorithm: "client", "server"(default), "ajax" Setter for switchType

Specified by:
setSwitchType in class UISimpleTogglePanel
Parameters:
switchType - - new value

getSwitchType

public java.lang.String getSwitchType()
Facets switch algorithm: "client", "server"(default), "ajax" Getter for switchType

Specified by:
getSwitchType in class UISimpleTogglePanel
Returns:
switchType value from local variable or value bindings

setTimeout

public void setTimeout(int __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

getTimeout

public int getTimeout()
Response waiting time on a particular request. If a response is not received during this time, the request is aborted Getter for timeout

Returns:
timeout value from local variable or value bindings

setWidth

public void setWidth(java.lang.String __width)
Width of a simple toggle panel might be defined as pixels or in percents. By default width is not defined Setter for width

Parameters:
width - - new value

getWidth

public java.lang.String getWidth()
Width of a simple toggle panel might be defined as pixels or in percents. By default width is not defined Getter for width

Returns:
width value from local variable or value bindings

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UICommand

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UICommand

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UICommand


Copyright © 2008. All Rights Reserved.