public class

ClientProperties

extends Object
implements Serializable
java.lang.Object
   ↳ org.apache.myfaces.tobago.context.ClientProperties

Class Overview

The ClientProperties contains data, which are individual for each user. It is stored in the session by default, but the application can override this in the faces-config.xml.

The managed bean name which is Tobago using for the instance is MANAGED_BEAN_NAME.

Please use resolveClientProperties(FacesContext) to access to the users client properties.

Summary

Constants
String MANAGED_BEAN_NAME The name of the managed bean
Public Constructors
ClientProperties()
managed bean constructor
Public Methods
String getContentType()
static ClientProperties getDefaultInstance(FacesContext facesContext)
This method is deprecated. since 1.5.
Measure getHorizontalScrollbarWeight()
static ClientProperties getInstance(UIViewRoot viewRoot)
This method is deprecated. since 1.5. Please use resolveClientProperties(javax.faces.context.FacesContext)
static ClientProperties getInstance(FacesContext facesContext)
This method is deprecated. since 1.5. Please use resolveClientProperties(javax.faces.context.FacesContext)
Locale getLocale()
static List<String> getLocaleList(Locale locale, boolean propertyPathMode)
This method is deprecated. since 1.5. Please use getLocaleSuffixList(java.util.Locale)
Theme getTheme()
UserAgent getUserAgent()
Measure getVerticalScrollbarWeight()
boolean isDebugMode()
void setContentType(String contentType)
void setDebugMode(boolean debugMode)
void setHorizontalScrollbarWeight(Measure horizontalScrollbarWeight)
void setLocale(Locale locale)
Holds the locale of the user, which is located in the UIViewRoot.
void setTheme(Theme theme)
void setUserAgent(UserAgent userAgent)
void setVerticalScrollbarWeight(Measure verticalScrollbarWeight)
void updateUserAgent(FacesContext facesContext)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String MANAGED_BEAN_NAME

The name of the managed bean

Constant Value: "tobagoClientProperties"

Public Constructors

public ClientProperties ()

managed bean constructor

Public Methods

public String getContentType ()

public static ClientProperties getDefaultInstance (FacesContext facesContext)

This method is deprecated.
since 1.5.

public Measure getHorizontalScrollbarWeight ()

public static ClientProperties getInstance (UIViewRoot viewRoot)

This method is deprecated.
since 1.5. Please use resolveClientProperties(javax.faces.context.FacesContext)

public static ClientProperties getInstance (FacesContext facesContext)

This method is deprecated.
since 1.5. Please use resolveClientProperties(javax.faces.context.FacesContext)

public Locale getLocale ()

public static List<String> getLocaleList (Locale locale, boolean propertyPathMode)

This method is deprecated.
since 1.5. Please use getLocaleSuffixList(java.util.Locale)

public Theme getTheme ()

public UserAgent getUserAgent ()

public Measure getVerticalScrollbarWeight ()

public boolean isDebugMode ()

public void setContentType (String contentType)

public void setDebugMode (boolean debugMode)

public void setHorizontalScrollbarWeight (Measure horizontalScrollbarWeight)

public void setLocale (Locale locale)

Holds the locale of the user, which is located in the UIViewRoot. This setter should not be called from the application directly, but via setLocale(Locale)

public void setTheme (Theme theme)

public void setUserAgent (UserAgent userAgent)

public void setVerticalScrollbarWeight (Measure verticalScrollbarWeight)

public void updateUserAgent (FacesContext facesContext)