org.alfresco.web.ui.repo.renderer

Class BaseMultiValueRenderer

java.lang.Object

javax.faces.render.Renderer

org.alfresco.web.ui.common.renderer.BaseRenderer

org.alfresco.web.ui.repo.renderer.BaseMultiValueRenderer

Direct Known Subclasses:

MultiValueFieldRenderer, MultiValueSelectorRenderer

public abstract class BaseMultiValueRenderer
extends BaseRenderer

Base class for renderers of the MultiValueEditor component. The current items are displayed as a list of options that can be removed using a Remove button.

Author:

gavinc

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	highlightedRow
protected static String	MSG_ADD_TO_LIST_BUTTON
protected static String	MSG_REMOVE I18N message strings
protected static String	MSG_SELECT_BUTTON

Constructor Summary

Constructors

Constructor and Description
BaseMultiValueRenderer()

Method Summary

Modifier and Type	Method and Description
void	decode(FacesContext context, UIComponent component)
void	encodeBegin(FacesContext context, UIComponent component)
void	encodeEnd(FacesContext context, UIComponent component)
protected String	generateFormSubmit(FacesContext context, UIComponent component, String action) Generate FORM submit JavaScript for the specified action
protected String	getHiddenFieldName(UIComponent component) We use a hidden field per picker instance on the page.
protected void	renderExistingItem(FacesContext context, UIComponent component, ResponseWriter out, org.alfresco.service.cmr.repository.NodeService nodeService, int index, Object value) Renders an existing item with a remove button
protected abstract void	renderPostWrappedComponent(FacesContext context, ResponseWriter out, UIMultiValueEditor editor) Renders the area of the component after the wrapped component but before the list of currently selected values.
protected abstract void	renderPreWrappedComponent(FacesContext context, ResponseWriter out, UIMultiValueEditor editor) Renders the area of the component before the wrapped component appears.

Methods inherited from class org.alfresco.web.ui.common.renderer.BaseRenderer

assertParmeters, getParameterComponents, outputAttribute

Methods inherited from class javax.faces.render.Renderer

convertClientId, encodeChildren, getConvertedValue, getRendersChildren

Methods inherited from class java.lang.Object

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

Field Detail

MSG_REMOVE

protected static final String MSG_REMOVE

I18N message strings

See Also:

Constant Field Values

MSG_SELECT_BUTTON

protected static final String MSG_SELECT_BUTTON

See Also:

Constant Field Values

MSG_ADD_TO_LIST_BUTTON

protected static final String MSG_ADD_TO_LIST_BUTTON

See Also:

Constant Field Values

highlightedRow

protected boolean highlightedRow

Constructor Detail

BaseMultiValueRenderer

public BaseMultiValueRenderer()

Method Detail

decode

public void decode(FacesContext context,
                   UIComponent component)

Overrides:

decode in class Renderer

See Also:

Renderer.decode(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

encodeBegin

public void encodeBegin(FacesContext context,
                        UIComponent component)
                 throws IOException

Overrides:

encodeBegin in class Renderer

Throws:

IOException

See Also:

Renderer.encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

encodeEnd

public void encodeEnd(FacesContext context,
                      UIComponent component)
               throws IOException

Overrides:

encodeEnd in class Renderer

Throws:

IOException

See Also:

Renderer.encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

renderPreWrappedComponent

protected abstract void renderPreWrappedComponent(FacesContext context,
                                                  ResponseWriter out,
                                                  UIMultiValueEditor editor)
                                           throws IOException

Renders the area of the component before the wrapped component appears.

Parameters:

context - FacesContext

out - The ResponseWriter to write to

editor - The multi value editor component

Throws:

IOException

renderPostWrappedComponent

protected abstract void renderPostWrappedComponent(FacesContext context,
                                                   ResponseWriter out,
                                                   UIMultiValueEditor editor)
                                            throws IOException

Renders the area of the component after the wrapped component but before the list of currently selected values.

Parameters:

context - FacesContext

out - The ResponseWriter to write to

editor - The multi value editor component

Throws:

IOException

renderExistingItem

protected void renderExistingItem(FacesContext context,
                                  UIComponent component,
                                  ResponseWriter out,
                                  org.alfresco.service.cmr.repository.NodeService nodeService,
                                  int index,
                                  Object value)
                           throws IOException

Renders an existing item with a remove button

Parameters:

context - FacesContext

component - The UIComponent

out - Writer to write output to

nodeService - The NodeService

index - The index of the item

value - The item's value

Throws:

IOException

getHiddenFieldName

protected String getHiddenFieldName(UIComponent component)

We use a hidden field per picker instance on the page.

Returns:

hidden field name

generateFormSubmit

protected String generateFormSubmit(FacesContext context,
                                    UIComponent component,
                                    String action)

Generate FORM submit JavaScript for the specified action

Parameters:

context - FacesContext

component - The UIComponent

action - Action string

Returns:

FORM submit JavaScript