org.apache.myfaces.tobago.context
Class ClientProperties

java.lang.Object
  extended by org.apache.myfaces.tobago.context.ClientProperties
All Implemented Interfaces:
Serializable

public class ClientProperties
extends Object
implements Serializable

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 VariableResolverUtils.resolveClientProperties(FacesContext) to access to the users client properties.

See Also:
Serialized Form

Field Summary
static String MANAGED_BEAN_NAME
          The name of the managed bean
 
Constructor Summary
ClientProperties()
          managed bean constructor
 
Method Summary
 String getContentType()
           
static ClientProperties getDefaultInstance(javax.faces.context.FacesContext facesContext)
          Deprecated. since 1.5.
 Measure getHorizontalScrollbarWeight()
           
static ClientProperties getInstance(javax.faces.context.FacesContext facesContext)
          Deprecated. since 1.5. Please use VariableResolverUtils.resolveClientProperties(javax.faces.context.FacesContext)
static ClientProperties getInstance(javax.faces.component.UIViewRoot viewRoot)
          Deprecated. since 1.5. Please use VariableResolverUtils.resolveClientProperties(javax.faces.context.FacesContext)
 Locale getLocale()
           
static List<String> getLocaleList(Locale locale, boolean propertyPathMode)
          Deprecated. since 1.5. Please use LocaleUtils.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(javax.faces.context.FacesContext facesContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MANAGED_BEAN_NAME

public static final String MANAGED_BEAN_NAME
The name of the managed bean

See Also:
Constant Field Values
Constructor Detail

ClientProperties

public ClientProperties()
managed bean constructor

Method Detail

getDefaultInstance

@Deprecated
public static ClientProperties getDefaultInstance(javax.faces.context.FacesContext facesContext)
Deprecated. since 1.5.


getInstance

@Deprecated
public static ClientProperties getInstance(javax.faces.component.UIViewRoot viewRoot)
Deprecated. since 1.5. Please use VariableResolverUtils.resolveClientProperties(javax.faces.context.FacesContext)


getInstance

@Deprecated
public static ClientProperties getInstance(javax.faces.context.FacesContext facesContext)
Deprecated. since 1.5. Please use VariableResolverUtils.resolveClientProperties(javax.faces.context.FacesContext)


getLocaleList

@Deprecated
public static List<String> getLocaleList(Locale locale,
                                                    boolean propertyPathMode)
Deprecated. since 1.5. Please use LocaleUtils.getLocaleSuffixList(java.util.Locale)


getContentType

public String getContentType()

setContentType

public void setContentType(String contentType)

getTheme

public Theme getTheme()

setTheme

public void setTheme(Theme theme)

getUserAgent

public UserAgent getUserAgent()

setUserAgent

public void setUserAgent(UserAgent userAgent)

isDebugMode

public boolean isDebugMode()

setDebugMode

public void setDebugMode(boolean debugMode)

getLocale

public Locale getLocale()

setLocale

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 UIViewRoot.setLocale(Locale locale)


getVerticalScrollbarWeight

public Measure getVerticalScrollbarWeight()

setVerticalScrollbarWeight

public void setVerticalScrollbarWeight(Measure verticalScrollbarWeight)

getHorizontalScrollbarWeight

public Measure getHorizontalScrollbarWeight()

setHorizontalScrollbarWeight

public void setHorizontalScrollbarWeight(Measure horizontalScrollbarWeight)

updateUserAgent

public void updateUserAgent(javax.faces.context.FacesContext facesContext)


Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.