org.apache.myfaces.tobago.taglib.extension
Class MenuCheckboxExtensionTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by org.apache.myfaces.tobago.taglib.extension.MenuCheckboxExtensionTag
All Implemented Interfaces:
java.io.Serializable, BodyTag, IterationTag, JspTag, Tag, AbstractCommandTagDeclaration, TobagoTagDeclaration, HasAction, HasActionListener, HasBinding, HasBooleanValue, HasId, HasIdBindingAndRendered, HasLabel, HasLink, HasOnclick, HasResource, IsDisabled, IsImmediateCommand, IsRendered, IsTransition

public class MenuCheckboxExtensionTag
extends BodyTagSupport
implements AbstractCommandTagDeclaration, HasIdBindingAndRendered, IsDisabled, HasBooleanValue, HasLabel

Renders a checkable menuitem.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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
MenuCheckboxExtensionTag()
           
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
 void release()
           
 void setAction(java.lang.String action)
          Action to invoke when clicked.
 void setActionListener(java.lang.String actionListener)
          MethodBinding representing an action listener method that will be notified when this component is activated by the user.
 void setBinding(java.lang.String binding)
          The value binding expression linking this component to a property in a backing bean.
 void setDisabled(java.lang.String disabled)
          Flag indicating that this element is disabled.
 void setImmediate(java.lang.String immediate)
          Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
 void setJsfResource(java.lang.String jsfResource)
          Flag indicating that the resource referenced by the resource attribute is a jsf resource.
 void setLabel(java.lang.String label)
          Text value to display as label.
 void setLink(java.lang.String navigate)
          Link to an arbitrary URL, either an internal link or an external link.
 void setOnclick(java.lang.String onclick)
          Script to be invoked when clicked
 void setRendered(java.lang.String rendered)
          Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
 void setResource(java.lang.String resource)
          Link to an internal resource.
 void setTransition(java.lang.String transition)
          Specify, if the command calls an JSF-Action.
 void setValue(java.lang.String value)
          The current value of this component.
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
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
getParent, setPageContext, setParent
 
Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasId
setId
 

Constructor Detail

MenuCheckboxExtensionTag

public MenuCheckboxExtensionTag()
Method Detail

doStartTag

public int doStartTag()
               throws JspException
Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class BodyTagSupport
Throws:
JspException

doEndTag

public int doEndTag()
             throws JspException
Specified by:
doEndTag in interface Tag
Overrides:
doEndTag in class BodyTagSupport
Throws:
JspException

setAction

public void setAction(java.lang.String action)
Description copied from interface: HasAction
Action to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The String is directly passed to the Navigationhandler.

Specified by:
setAction in interface HasAction

setActionListener

public void setActionListener(java.lang.String actionListener)
Description copied from interface: HasActionListener
MethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.

Specified by:
setActionListener in interface HasActionListener

setOnclick

public void setOnclick(java.lang.String onclick)
Description copied from interface: HasOnclick
Script to be invoked when clicked

Specified by:
setOnclick in interface HasOnclick

setLink

public void setLink(java.lang.String navigate)
Description copied from interface: HasLink
Link to an arbitrary URL, either an internal link or an external link.
internal absolute link
Starts with a slash '/' character. The context path will be added. A session id will be added, if needed.
external link
Contains a colon ':' character. The link will not be modified.
internal relative link
Any other strings. A session id will be added, if needed.

Specified by:
setLink in interface HasLink
Parameters:
navigate - The external or internal link.

setResource

public void setResource(java.lang.String resource)
Description copied from interface: HasResource
Link to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.

Specified by:
setResource in interface HasResource
Parameters:
resource - The internal resource.
See Also:
HasResource.setJsfResource(String)

setJsfResource

public void setJsfResource(java.lang.String jsfResource)
Description copied from interface: HasResource
Flag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.

Specified by:
setJsfResource in interface HasResource
Parameters:
jsfResource - Is the Resource a JSF page or not?

setBinding

public void setBinding(java.lang.String binding)
                throws JspException
Description copied from interface: HasBinding
The value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:

Specified by:
setBinding in interface HasBinding
Throws:
JspException

setRendered

public void setRendered(java.lang.String rendered)
Description copied from interface: IsRendered
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.

Specified by:
setRendered in interface IsRendered

setDisabled

public void setDisabled(java.lang.String disabled)
Description copied from interface: IsDisabled
Flag indicating that this element is disabled.

Specified by:
setDisabled in interface IsDisabled

setValue

public void setValue(java.lang.String value)
Description copied from interface: HasBooleanValue
The current value of this component.

Specified by:
setValue in interface HasBooleanValue

setLabel

public void setLabel(java.lang.String label)
Description copied from interface: HasLabel
Text value to display as label. If text contains an underscore the next character is used as accesskey.

Specified by:
setLabel in interface HasLabel

setImmediate

public void setImmediate(java.lang.String immediate)
Description copied from interface: IsImmediateCommand
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.

Specified by:
setImmediate in interface IsImmediateCommand

setTransition

public void setTransition(java.lang.String transition)
Description copied from interface: IsTransition
Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.

Specified by:
setTransition in interface IsTransition
Parameters:
transition - Indicates the transition.

release

public void release()
Specified by:
release in interface Tag
Overrides:
release in class BodyTagSupport


Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.