org.apache.myfaces.tobago.context

Class ResourceManagerUtils

java.lang.Object

org.apache.myfaces.tobago.context.ResourceManagerUtils

public final class ResourceManagerUtils
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static String	getBlankPage(javax.faces.context.FacesContext facesContext) Blank page e. g. useful to set src of iframes (to prevent https problems in ie, see TOBAGO-538)
static String	getDisabledImage(javax.faces.context.FacesContext facesContext, String image, boolean ignoreMissing)
static String	getDisabledImageWithPath(javax.faces.context.FacesContext facesContext, String image, boolean ignoreMissing)
static String	getFile(javax.faces.context.FacesContext facesContext, String name, String extension, boolean ignoreMissing) Searches for an file and return it with the context path.
static String	getImage(javax.faces.context.FacesContext facesContext, String name) Searches for an image and return it with the context path.
static String	getImage(javax.faces.context.FacesContext facesContext, String name, boolean ignoreMissing) Searches for an image and return it with the context path.
static String	getImageOrDisabledImage(javax.faces.context.FacesContext facesContext, String image, boolean disabled)
static String	getImageOrDisabledImage(javax.faces.context.FacesContext facesContext, String image, boolean disabled, boolean ignoreMissing)
static String	getImageOrDisabledImageWithPath(javax.faces.context.FacesContext facesContext, String image, boolean disabled)
static String	getImageOrDisabledImageWithPath(javax.faces.context.FacesContext facesContext, String image, boolean disabled, boolean ignoreMissing)
static String	getImageWithPath(javax.faces.context.FacesContext facesContext, String name) Searches for an image and return it with the context path
static String	getImageWithPath(javax.faces.context.FacesContext facesContext, String name, boolean ignoreMissing) Searches for an image and return it with the context path
static String	getPageWithoutContextPath(javax.faces.context.FacesContext facesContext, String name)
static String	getProperty(javax.faces.context.FacesContext facesContext, String bundle, String key)
static String	getPropertyNotNull(javax.faces.context.FacesContext facesContext, String bundle, String key)
static List<String>	getScripts(javax.faces.context.FacesContext facesContext, String name)
static List<String>	getStyles(javax.faces.context.FacesContext facesContext, String name)
static Measure	getThemeMeasure(javax.faces.context.FacesContext facesContext, Visual visual, String name)
static int	indexOfExtension(String value)
static boolean	isAbsoluteResource(String value) Detects if the value is an absolute resource or if the value has to be processed by the theme mechanism.

Methods inherited from class java.lang.Object

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

Method Detail

getProperty

public static String getProperty(javax.faces.context.FacesContext facesContext,
                 String bundle,
                 String key)

getPropertyNotNull

public static String getPropertyNotNull(javax.faces.context.FacesContext facesContext,
                        String bundle,
                        String key)

getImageWithPath

public static String getImageWithPath(javax.faces.context.FacesContext facesContext,
                      String name)

Searches for an image and return it with the context path

Parameters:

facesContext - the current FacesContext

name - the name of the image with extension

getImageWithPath

public static String getImageWithPath(javax.faces.context.FacesContext facesContext,
                      String name,
                      boolean ignoreMissing)

Searches for an image and return it with the context path

Parameters:

facesContext - the current FacesContext

name - the name of the image with extension

ignoreMissing - if set to false, an error message will be logged, when image is missing

getFile

public static String getFile(javax.faces.context.FacesContext facesContext,
             String name,
             String extension,
             boolean ignoreMissing)

Searches for an file and return it with the context path.

Parameters:

facesContext - the current FacesContext

name - the name of the file without extension

extension - the file extension

ignoreMissing - if set to false, an error message will be logged, when image is missing

getImage

public static String getImage(javax.faces.context.FacesContext facesContext,
              String name)

Searches for an image and return it with the context path. The extension of the image will be automatically extended (.png, .gif, .jpg). A missing image will be logged as an error.

Parameters:

facesContext - the current FacesContext

name - the name of the image without extension

getImage

public static String getImage(javax.faces.context.FacesContext facesContext,
              String name,
              boolean ignoreMissing)

Searches for an image and return it with the context path. The extension of the image will be automatically extended (.png, .gif, .jpg)

Parameters:

facesContext - the current FacesContext

name - the name of the image without extension

ignoreMissing - if set to false, an error message will be logged, when image is missing

getStyles

public static List<String> getStyles(javax.faces.context.FacesContext facesContext,
                     String name)

getScripts

public static List<String> getScripts(javax.faces.context.FacesContext facesContext,
                      String name)

getDisabledImageWithPath

public static String getDisabledImageWithPath(javax.faces.context.FacesContext facesContext,
                              String image,
                              boolean ignoreMissing)

getDisabledImage

public static String getDisabledImage(javax.faces.context.FacesContext facesContext,
                      String image,
                      boolean ignoreMissing)

getBlankPage

public static String getBlankPage(javax.faces.context.FacesContext facesContext)

Blank page e. g. useful to set src of iframes (to prevent https problems in ie, see TOBAGO-538)

getPageWithoutContextPath

public static String getPageWithoutContextPath(javax.faces.context.FacesContext facesContext,
                               String name)

getThemeMeasure

public static Measure getThemeMeasure(javax.faces.context.FacesContext facesContext,
                      Visual visual,
                      String name)

isAbsoluteResource

public static boolean isAbsoluteResource(String value)

Detects if the value is an absolute resource or if the value has to be processed by the theme mechanism. A resource will be treated as absolute, if the value starts with HTTP:, HTTPS:, FTP: or a slash. The case will be ignored by this check. Null values will return true.

Parameters:

value - the given resource link.

Returns:

true if it is an external or absolute resource.

indexOfExtension

public static int indexOfExtension(String value)

getImageOrDisabledImageWithPath

public static String getImageOrDisabledImageWithPath(javax.faces.context.FacesContext facesContext,
                                     String image,
                                     boolean disabled)

getImageOrDisabledImageWithPath

public static String getImageOrDisabledImageWithPath(javax.faces.context.FacesContext facesContext,
                                     String image,
                                     boolean disabled,
                                     boolean ignoreMissing)

getImageOrDisabledImage

public static String getImageOrDisabledImage(javax.faces.context.FacesContext facesContext,
                             String image,
                             boolean disabled)

getImageOrDisabledImage

public static String getImageOrDisabledImage(javax.faces.context.FacesContext facesContext,
                             String image,
                             boolean disabled,
                             boolean ignoreMissing)