org.nuxeo.ecm.platform.ui.web.util

Class ComponentUtils

java.lang.Object

org.nuxeo.ecm.platform.ui.web.util.ComponentUtils

public final class ComponentUtils
extends Object

Generic component helper methods.

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORCE_NO_CACHE_ON_MSIE
static String	NUXEO_RESOURCE_RELOCATED
static String	WHITE_SPACE_CHARACTER

Method Summary

Modifier and Type	Method and Description
static void	addErrorMessage(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String message)
static void	addErrorMessage(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String message, Object[] params)
static void	copyLinkValues(javax.faces.component.UIComponent parent, javax.faces.component.UIComponent child)
static void	copyValues(javax.faces.component.UIComponent parent, javax.faces.component.UIComponent child, String[] valueNames) Copies attributes and value expressions with given name from parent component to child component.
static void	download(DocumentModel doc, String xpath, Blob blob, String filename, String reason) Downloads a blob and sends it to the requesting user, in the JSF current context.
static void	download(DocumentModel doc, String xpath, Blob blob, String filename, String reason, Map<String,Serializable> extendedInfos) Downloads a blob and sends it to the requesting user, in the JSF current context.
static String	download(javax.faces.context.FacesContext faces, Blob blob, String filename) Deprecated. since 7.3, use #downloadFile(Blob, String) instead
static String	downloadFile(javax.faces.context.FacesContext faces, String filename, File file) Deprecated. since 7.3, use #downloadFile(File, String) instead
static String	downloadFile(File file, String filename, String reason)
static void	encodeComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Calls a component encodeBegin/encodeChildren/encodeEnd methods.
protected static Object[]	evaluateParams(javax.faces.context.FacesContext context, Object[] params) Evaluates parameters to pass to translation methods if they are value expressions.
protected static boolean	forceNoCacheOnMSIE()
static Object	getAttributeOrExpressionValue(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String attributeName, Object defaultValue)
static <T> T	getAttributeValue(javax.faces.component.UIComponent component, String name, Class<T> klass, T defaultValue, boolean required)
static Object	getAttributeValue(javax.faces.component.UIComponent component, String attributeName, Object defaultValue)
static javax.faces.component.UIComponent	getBase(javax.faces.component.UIComponent anchor) Gets the base naming container from anchor.
static <T> T	getComponent(javax.faces.component.UIComponent base, String componentId, Class<T> expectedComponentClass) Returns the component specified by the componentId parameter from the base component.
static javax.faces.component.UIComponent	hookSubComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent, javax.faces.component.UIComponent child, String defaultChildId) Add a sub component to a UI component.
static void	initiateSubComponent(javax.faces.component.UIComponent parent, String facetName, javax.faces.component.UIComponent child) Helper method meant to be called in the component constructor.
static boolean	isRelocated(javax.faces.component.UIComponent component) Returns true if given component is marked as relocated.
protected static boolean	isRendered(javax.faces.component.UIComponent component)
static void	moveAllItems(javax.faces.component.UISelectItems sourceItems, javax.faces.component.UISelectItems targetItems, UIEditableList hiddenTargetList, boolean setTargetIds) Move items from components to others.
static void	moveItems(javax.faces.component.UISelectMany sourceSelect, javax.faces.component.UISelectItems sourceItems, javax.faces.component.UISelectItems targetItems, UIEditableList hiddenTargetList, boolean setTargetIds) Move items from components to others.
static void	relocate(javax.faces.component.UIComponent component, String target, String compositeKey) Relocates given component, adding it to the view root resources for given target.
static void	setRelocated(javax.faces.component.UIComponent component) Marks given component as relocated, so that subsequent calls to isRelocated(UIComponent) returns true.
static void	shiftItemsDown(javax.faces.component.UISelectMany targetSelect, javax.faces.component.UISelectItems targetItems, UIEditableList hiddenTargetList)
static void	shiftItemsFirst(javax.faces.component.UISelectMany targetSelect, javax.faces.component.UISelectItems targetItems, UIEditableList hiddenTargetList)
static void	shiftItemsLast(javax.faces.component.UISelectMany targetSelect, javax.faces.component.UISelectItems targetItems, UIEditableList hiddenTargetList)
static void	shiftItemsUp(javax.faces.component.UISelectMany targetSelect, javax.faces.component.UISelectItems targetItems, UIEditableList hiddenTargetList) Move items up inside the target select
static String	translate(javax.faces.context.FacesContext context, String messageId)
static String	translate(javax.faces.context.FacesContext context, String messageId, Object... params)
static String	verifyTarget(String toVerify, String defaultTarget)

Methods inherited from class java.lang.Object

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

Field Detail

WHITE_SPACE_CHARACTER

public static final String WHITE_SPACE_CHARACTER

See Also:

Constant Field Values

FORCE_NO_CACHE_ON_MSIE

public static final String FORCE_NO_CACHE_ON_MSIE

See Also:

Constant Field Values

NUXEO_RESOURCE_RELOCATED

public static final String NUXEO_RESOURCE_RELOCATED

See Also:

Constant Field Values

Method Detail

encodeComponent

public static void encodeComponent(javax.faces.context.FacesContext context,
                                   javax.faces.component.UIComponent component)
                            throws IOException

Calls a component encodeBegin/encodeChildren/encodeEnd methods.

Throws:

IOException

initiateSubComponent

public static void initiateSubComponent(javax.faces.component.UIComponent parent,
                                        String facetName,
                                        javax.faces.component.UIComponent child)

Helper method meant to be called in the component constructor.

When adding sub components dynamically, the tree fetching could be a problem so all possible sub components must be added.

Since 6.0, does not mark component as not rendered anymore, calls hookSubComponent(FacesContext, UIComponent, UIComponent, String) directly.

Parameters:

parent -

child -

facetName - facet name to put the child in.

hookSubComponent

public static javax.faces.component.UIComponent hookSubComponent(javax.faces.context.FacesContext context,
                                                                 javax.faces.component.UIComponent parent,
                                                                 javax.faces.component.UIComponent child,
                                                                 String defaultChildId)

Add a sub component to a UI component.

Since 6.0, does not the set the component as rendered anymore.

Parameters:

context -

parent -

child -

defaultChildId -

Returns:

child comp

copyValues

public static void copyValues(javax.faces.component.UIComponent parent,
                              javax.faces.component.UIComponent child,
                              String[] valueNames)

Copies attributes and value expressions with given name from parent component to child component.

copyLinkValues

public static void copyLinkValues(javax.faces.component.UIComponent parent,
                                  javax.faces.component.UIComponent child)

getAttributeValue

public static Object getAttributeValue(javax.faces.component.UIComponent component,
                                       String attributeName,
                                       Object defaultValue)

getAttributeValue

public static <T> T getAttributeValue(javax.faces.component.UIComponent component,
                                      String name,
                                      Class<T> klass,
                                      T defaultValue,
                                      boolean required)

Since:

8.2

getAttributeOrExpressionValue

public static Object getAttributeOrExpressionValue(javax.faces.context.FacesContext context,
                                                   javax.faces.component.UIComponent component,
                                                   String attributeName,
                                                   Object defaultValue)

download

public static void download(DocumentModel doc,
                            String xpath,
                            Blob blob,
                            String filename,
                            String reason)

Downloads a blob and sends it to the requesting user, in the JSF current context.

Parameters:

doc - the document, if available

xpath - the blob's xpath or blobholder index, if available

blob - the blob, if already fetched

filename - the filename to use

reason - the download reason

Since:

7.3

download

public static void download(DocumentModel doc,
                            String xpath,
                            Blob blob,
                            String filename,
                            String reason,
                            Map<String,Serializable> extendedInfos)

Downloads a blob and sends it to the requesting user, in the JSF current context.

Parameters:

doc - the document, if available

xpath - the blob's xpath or blobholder index, if available

blob - the blob, if already fetched

filename - the filename to use

reason - the download reason

extendedInfos - an optional map of extended informations to log

Since:

7.3

downloadFile

public static String downloadFile(File file,
                                  String filename,
                                  String reason)
                           throws IOException

Throws:

IOException

download

@Deprecated
public static String download(javax.faces.context.FacesContext faces,
                                          Blob blob,
                                          String filename)

Deprecated. since 7.3, use #downloadFile(Blob, String) instead

downloadFile

@Deprecated
public static String downloadFile(javax.faces.context.FacesContext faces,
                                              String filename,
                                              File file)
                                       throws IOException

Deprecated. since 7.3, use #downloadFile(File, String) instead

Throws:

IOException

forceNoCacheOnMSIE

protected static boolean forceNoCacheOnMSIE()

translate

public static String translate(javax.faces.context.FacesContext context,
                               String messageId)

translate

public static String translate(javax.faces.context.FacesContext context,
                               String messageId,
                               Object... params)

addErrorMessage

public static void addErrorMessage(javax.faces.context.FacesContext context,
                                   javax.faces.component.UIComponent component,
                                   String message)

addErrorMessage

public static void addErrorMessage(javax.faces.context.FacesContext context,
                                   javax.faces.component.UIComponent component,
                                   String message,
                                   Object[] params)

evaluateParams

protected static Object[] evaluateParams(javax.faces.context.FacesContext context,
                                         Object[] params)

Evaluates parameters to pass to translation methods if they are value expressions.

Since:

5.7

getBase

public static javax.faces.component.UIComponent getBase(javax.faces.component.UIComponent anchor)

Gets the base naming container from anchor.

Gets out of suggestion box as it's a naming container and we can't get components out of it with a relative path => take above first found container.

Since:

5.3.1

getComponent

public static <T> T getComponent(javax.faces.component.UIComponent base,
                                 String componentId,
                                 Class<T> expectedComponentClass)

Returns the component specified by the componentId parameter from the base component.

Does not throw any exception if the component is not found, returns null instead.

Since:

5.4

shiftItemsUp

public static void shiftItemsUp(javax.faces.component.UISelectMany targetSelect,
                                javax.faces.component.UISelectItems targetItems,
                                UIEditableList hiddenTargetList)

Move items up inside the target select

shiftItemsDown

public static void shiftItemsDown(javax.faces.component.UISelectMany targetSelect,
                                  javax.faces.component.UISelectItems targetItems,
                                  UIEditableList hiddenTargetList)

shiftItemsFirst

public static void shiftItemsFirst(javax.faces.component.UISelectMany targetSelect,
                                   javax.faces.component.UISelectItems targetItems,
                                   UIEditableList hiddenTargetList)

shiftItemsLast

public static void shiftItemsLast(javax.faces.component.UISelectMany targetSelect,
                                  javax.faces.component.UISelectItems targetItems,
                                  UIEditableList hiddenTargetList)

moveItems

public static void moveItems(javax.faces.component.UISelectMany sourceSelect,
                             javax.faces.component.UISelectItems sourceItems,
                             javax.faces.component.UISelectItems targetItems,
                             UIEditableList hiddenTargetList,
                             boolean setTargetIds)

Move items from components to others.

moveAllItems

public static void moveAllItems(javax.faces.component.UISelectItems sourceItems,
                                javax.faces.component.UISelectItems targetItems,
                                UIEditableList hiddenTargetList,
                                boolean setTargetIds)

Move items from components to others.

verifyTarget

public static String verifyTarget(String toVerify,
                                  String defaultTarget)

setRelocated

public static void setRelocated(javax.faces.component.UIComponent component)

Marks given component as relocated, so that subsequent calls to isRelocated(UIComponent) returns true.

Since:

8.1

isRelocated

public static boolean isRelocated(javax.faces.component.UIComponent component)

Returns true if given component is marked as relocated.

Since:

8.1

See Also:

setRelocated(UIComponent), relocate(UIComponent, String, String)

relocate

public static void relocate(javax.faces.component.UIComponent component,
                            String target,
                            String compositeKey)

Relocates given component, adding it to the view root resources for given target.

If given composite key is not null, current composite component client id is saved using this key on the component attributes, for later reuse.

Component is also marked as relocated so that subsequent calls to isRelocated(UIComponent) returns true.

Since:

8.1

isRendered

protected static boolean isRendered(javax.faces.component.UIComponent component)