org.opencms.loader

Class CmsClientVariant

java.lang.Object

org.opencms.loader.CmsClientVariant

public class CmsClientVariant
extends java.lang.Object

Bean that represents a client variant of a template context.

Constructor Summary

Constructors

Constructor and Description
CmsClientVariant(java.lang.String name, I_CmsMessageContainer message, int width, int height, java.util.Map<java.lang.String,java.lang.String> parameters) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Gets the internal name.
java.lang.String	getNiceName(java.util.Locale locale) Gets the nice name for a locale.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Gets the parameters.
int	getScreenHeight() Gets the screen height.
int	getScreenWidth() Gets the screen width.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsClientVariant

public CmsClientVariant(java.lang.String name,
                I_CmsMessageContainer message,
                int width,
                int height,
                java.util.Map<java.lang.String,java.lang.String> parameters)

Creates a new instance.

Parameters:

name - the internal name of the client variant

message - the nice name of the variant

width - the screen width

height - the screen height

parameters - parameters for the variant

Method Detail

getName

public java.lang.String getName()

Gets the internal name.

Returns:

the name

getNiceName

public java.lang.String getNiceName(java.util.Locale locale)

Gets the nice name for a locale.

Parameters:

locale - the locale

Returns:

the nice name

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Gets the parameters.

Returns:

the parameters

getScreenHeight

public int getScreenHeight()

Gets the screen height.

Returns:

the screen height

getScreenWidth

public int getScreenWidth()

Gets the screen width.

Returns:

the screen width