Class SelectManyListboxTag
- All Implemented Interfaces:
jakarta.servlet.jsp.tagext.BodyTag,jakarta.servlet.jsp.tagext.IterationTag,jakarta.servlet.jsp.tagext.JspIdConsumer,jakarta.servlet.jsp.tagext.JspTag,jakarta.servlet.jsp.tagext.Tag
public class SelectManyListboxTag extends UIComponentELTag
-
Field Summary
Fields inherited from class jakarta.faces.webapp.UIComponentClassicTagBase
bodyContent, pageContext, UNIQUE_ID_PREFIX -
Constructor Summary
Constructors Constructor Description SelectManyListboxTag() -
Method Summary
Modifier and Type Method Description intdoEndTag()Perform any processing necessary to handle the content implications of CASE 3 in the class description.intdoStartTag()Perform any processing necessary to find (or create) theUIComponentinstance in the view corresponding to this tag instance in the page and, if and only if a component was created, insert it into the tree at the proper location as expected by the page author.StringgetComponentType()Return the component type for the component that is or will be bound to this tag.StringgetDebugString()StringgetRendererType()Return therendererTypeproperty that selects theRendererto be used for encoding this component, ornullto ask the component to render itself directly.voidrelease()Release any resources allocated during the execution of this tag handler.voidsetAccesskey(jakarta.el.ValueExpression accesskey)voidsetCollectionType(jakarta.el.ValueExpression collectionType)voidsetConverter(jakarta.el.ValueExpression converter)voidsetConverterMessage(jakarta.el.ValueExpression converterMessage)voidsetDir(jakarta.el.ValueExpression dir)voidsetDisabled(jakarta.el.ValueExpression disabled)voidsetDisabledClass(jakarta.el.ValueExpression disabledClass)voidsetEnabledClass(jakarta.el.ValueExpression enabledClass)voidsetHideNoSelectionOption(jakarta.el.ValueExpression hideNoSelectionOption)voidsetImmediate(jakarta.el.ValueExpression immediate)voidsetLabel(jakarta.el.ValueExpression label)voidsetLang(jakarta.el.ValueExpression lang)voidsetOnblur(jakarta.el.ValueExpression onblur)voidsetOnchange(jakarta.el.ValueExpression onchange)voidsetOnclick(jakarta.el.ValueExpression onclick)voidsetOndblclick(jakarta.el.ValueExpression ondblclick)voidsetOnfocus(jakarta.el.ValueExpression onfocus)voidsetOnkeydown(jakarta.el.ValueExpression onkeydown)voidsetOnkeypress(jakarta.el.ValueExpression onkeypress)voidsetOnkeyup(jakarta.el.ValueExpression onkeyup)voidsetOnmousedown(jakarta.el.ValueExpression onmousedown)voidsetOnmousemove(jakarta.el.ValueExpression onmousemove)voidsetOnmouseout(jakarta.el.ValueExpression onmouseout)voidsetOnmouseover(jakarta.el.ValueExpression onmouseover)voidsetOnmouseup(jakarta.el.ValueExpression onmouseup)voidsetOnselect(jakarta.el.ValueExpression onselect)protected voidsetProperties(UIComponent component)Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set.voidsetReadonly(jakarta.el.ValueExpression readonly)voidsetRequired(jakarta.el.ValueExpression required)voidsetRequiredMessage(jakarta.el.ValueExpression requiredMessage)voidsetRole(jakarta.el.ValueExpression role)voidsetSize(jakarta.el.ValueExpression size)voidsetStyle(jakarta.el.ValueExpression style)voidsetStyleClass(jakarta.el.ValueExpression styleClass)voidsetTabindex(jakarta.el.ValueExpression tabindex)voidsetTitle(jakarta.el.ValueExpression title)voidsetValidator(jakarta.el.MethodExpression validator)voidsetValidatorMessage(jakarta.el.ValueExpression validatorMessage)voidsetValue(jakarta.el.ValueExpression value)voidsetValueChangeListener(jakarta.el.MethodExpression valueChangeListener)Methods inherited from class jakarta.faces.webapp.UIComponentELTag
createComponent, getELContext, hasBinding, setBinding, setRenderedMethods inherited from class jakarta.faces.webapp.UIComponentClassicTagBase
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doInitBody, 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
-
Constructor Details
-
SelectManyListboxTag
public SelectManyListboxTag()
-
-
Method Details
-
setConverter
public void setConverter(jakarta.el.ValueExpression converter) -
setConverterMessage
public void setConverterMessage(jakarta.el.ValueExpression converterMessage) -
setImmediate
public void setImmediate(jakarta.el.ValueExpression immediate) -
setRequired
public void setRequired(jakarta.el.ValueExpression required) -
setRequiredMessage
public void setRequiredMessage(jakarta.el.ValueExpression requiredMessage) -
setValidator
public void setValidator(jakarta.el.MethodExpression validator) -
setValidatorMessage
public void setValidatorMessage(jakarta.el.ValueExpression validatorMessage) -
setValue
public void setValue(jakarta.el.ValueExpression value) -
setValueChangeListener
public void setValueChangeListener(jakarta.el.MethodExpression valueChangeListener) -
setAccesskey
public void setAccesskey(jakarta.el.ValueExpression accesskey) -
setCollectionType
public void setCollectionType(jakarta.el.ValueExpression collectionType) -
setDir
public void setDir(jakarta.el.ValueExpression dir) -
setDisabled
public void setDisabled(jakarta.el.ValueExpression disabled) -
setDisabledClass
public void setDisabledClass(jakarta.el.ValueExpression disabledClass) -
setEnabledClass
public void setEnabledClass(jakarta.el.ValueExpression enabledClass) -
setHideNoSelectionOption
public void setHideNoSelectionOption(jakarta.el.ValueExpression hideNoSelectionOption) -
setLabel
public void setLabel(jakarta.el.ValueExpression label) -
setLang
public void setLang(jakarta.el.ValueExpression lang) -
setOnblur
public void setOnblur(jakarta.el.ValueExpression onblur) -
setOnchange
public void setOnchange(jakarta.el.ValueExpression onchange) -
setOnclick
public void setOnclick(jakarta.el.ValueExpression onclick) -
setOndblclick
public void setOndblclick(jakarta.el.ValueExpression ondblclick) -
setOnfocus
public void setOnfocus(jakarta.el.ValueExpression onfocus) -
setOnkeydown
public void setOnkeydown(jakarta.el.ValueExpression onkeydown) -
setOnkeypress
public void setOnkeypress(jakarta.el.ValueExpression onkeypress) -
setOnkeyup
public void setOnkeyup(jakarta.el.ValueExpression onkeyup) -
setOnmousedown
public void setOnmousedown(jakarta.el.ValueExpression onmousedown) -
setOnmousemove
public void setOnmousemove(jakarta.el.ValueExpression onmousemove) -
setOnmouseout
public void setOnmouseout(jakarta.el.ValueExpression onmouseout) -
setOnmouseover
public void setOnmouseover(jakarta.el.ValueExpression onmouseover) -
setOnmouseup
public void setOnmouseup(jakarta.el.ValueExpression onmouseup) -
setOnselect
public void setOnselect(jakarta.el.ValueExpression onselect) -
setReadonly
public void setReadonly(jakarta.el.ValueExpression readonly) -
setRole
public void setRole(jakarta.el.ValueExpression role) -
setSize
public void setSize(jakarta.el.ValueExpression size) -
setStyle
public void setStyle(jakarta.el.ValueExpression style) -
setStyleClass
public void setStyleClass(jakarta.el.ValueExpression styleClass) -
setTabindex
public void setTabindex(jakarta.el.ValueExpression tabindex) -
setTitle
public void setTitle(jakarta.el.ValueExpression title) -
getRendererType
Description copied from class:UIComponentTagBaseReturn the
rendererTypeproperty that selects theRendererto be used for encoding this component, ornullto ask the component to render itself directly. Subclasses must override this method to return the appropriate value.- Specified by:
getRendererTypein classUIComponentTagBase- Returns:
- the renderer type
-
getComponentType
Description copied from class:UIComponentTagBaseReturn the component type for the component that is or will be bound to this tag. This value can be passed to
Application.createComponent(java.lang.String)to create theUIComponentinstance for this tag. Subclasses must override this method to return the appropriate value.- Specified by:
getComponentTypein classUIComponentTagBase- Returns:
- the component type
-
setProperties
Description copied from class:UIComponentELTagOverride properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified
UIComponentwas in fact created during the execution of this tag handler instance, and this call will occur BEFORE theUIComponentis added to the view.Tag subclasses that want to support additional set properties must ensure that the base class
setProperties()method is still called. A typical implementation that supports extra propertiesfooandbarwould look something like this:protected void setProperties(UIComponent component) { super.setProperties(component); if (foo != null) { component.setAttribute("foo", foo); } if (bar != null) { component.setAttribute("bar", bar); } }The default implementation overrides the following properties:
rendered- Set if a value for therenderedproperty is specified for this tag handler instance.rendererType- Set if thegetRendererType()method returns a non-null value.
- Overrides:
setPropertiesin classUIComponentELTag- Parameters:
component-UIComponentwhose properties are to be overridden
-
doStartTag
public int doStartTag() throws jakarta.servlet.jsp.JspExceptionDescription copied from class:UIComponentClassicTagBasePerform any processing necessary to find (or create) the
UIComponentinstance in the view corresponding to this tag instance in the page and, if and only if a component was created, insert it into the tree at the proper location as expected by the page author. Secondarily, cause a transientUIOutputcomponent to be created and placed in the tree before theUIComponentinstance for this tag. The value of thisUIOutputcomponent must include anything covered byCASE 1orCASE 2in the class description.The default implementation, which is intended to be sufficient for most components, implements this secondary requirement by calling
UIComponentClassicTagBase.getParentUIComponentClassicTagBase(jakarta.servlet.jsp.PageContext), and callingUIComponentClassicTagBase.createVerbatimComponentFromBodyContent()on the result. It then adds the returned component to the tree before the actual component for this tag instance instance by callingUIComponentClassicTagBase.addVerbatimBeforeComponent(jakarta.faces.webapp.UIComponentClassicTagBase, jakarta.faces.component.UIComponent, jakarta.faces.component.UIComponent).Before returning, the component is pushed onto the component stack for this response to enable the
UIComponentClassicTagBase.getParentUIComponentClassicTagBase(jakarta.servlet.jsp.PageContext)method to work properly.The flag value to be returned is acquired by calling the
getDoStartValue()method, which tag subclasses may override if they do not want the default value.- Specified by:
doStartTagin interfacejakarta.servlet.jsp.tagext.Tag- Overrides:
doStartTagin classUIComponentClassicTagBase- Throws:
jakarta.servlet.jsp.JspException- if an error occurs
-
doEndTag
public int doEndTag() throws jakarta.servlet.jsp.JspExceptionDescription copied from class:UIComponentClassicTagBasePerform any processing necessary to handle the content implications of CASE 3 in the class description.
The default implementation, which is intended to be sufficient for most components, calls
UIComponentClassicTagBase.createVerbatimComponentFromBodyContent()on this instance and adds it as a child of the component for this tag's component at the end of the child list. In addition, the following housekeeping steps are taken.- Retrieve from the
UIComponentthe set of component ids of child components created byUIComponentTaginstances the last time this page was processed (if any). Compare it to the list of children created during this page processing pass, and remove all children present in the old list but not the new. Save the new list as a component attribute so that it gets saved as part of the component's state. - Retrieve from the
UIComponentthe set of facet names of facets created byUIComponentTaginstances the last time this page was processed (if any). Compare it to the list of facets created during this page processing pass, and remove all facets present in the old list but not the new. Save the new list as a component attribute so that it gets saved as part of the component's state. - Release all references to the component, and pop it from the component stack for this response, removing the stack if this was the outermost component.
The flag value to be returned is acquired by calling the
getDoEndValue()method, which tag subclasses may override if they do not want the default value.- Specified by:
doEndTagin interfacejakarta.servlet.jsp.tagext.Tag- Overrides:
doEndTagin classUIComponentClassicTagBase- Throws:
jakarta.servlet.jsp.JspException- if an error occurs
- Retrieve from the
-
release
public void release()Description copied from class:UIComponentELTagRelease any resources allocated during the execution of this tag handler.
- Specified by:
releasein interfacejakarta.servlet.jsp.tagext.Tag- Overrides:
releasein classUIComponentELTag
-
getDebugString
-