Package de.uplanet.lucy.server.renderer

Class RenderingContext

java.lang.Object

de.uplanet.lucy.server.renderer.RenderingContext

All Implemented Interfaces:

IRenderingContext, Cloneable

public class RenderingContext
extends Object
implements IRenderingContext, Cloneable

Constructor Summary

Constructors

Constructor	Description
RenderingContext()

Method Summary

Modifier and Type	Method	Description
Object	clone()
String	getCurrencyDecimalSeparator()	Get the currency decimal separator.
String	getCurrencyDigitSeparator()	Get the currency digit separator.
int	getCurrencyFractionDigits()	Get the number of fraction digits for currency values.
String	getDateFormat()	Get the date format string.
String	getDateTimeFormat()	Get the date/time format string.
int	getFirstDayOfWeek()	Get the first day of the week.
String	getIntegerDigitSeparator()	Get the integer digit separator.
String	getLanguage()	Get the language identifier.
String	getLongDateFormat()	Get the long date format string.
String	getNumberDecimalSeparator()	Get the number decimal separator.
String	getNumberDigitSeparator()	Get the number digit separator.
int	getNumberFractionDigits()	Get the number of fraction digits of floating point numbers.
Object	getParam(String p_strName)	Get a parameter.
RoundingMode	getRoundingMode()	Get the rounding mode.
String	getShortDateFormat()	Get the short date format string.
String	getTimeFormat()	Get the time format string.
TimeZone	getTimeZone()	Get the time zone.
boolean	isCurrencyAlwaysShowIntegerPart()	Determine if currency values less than 1 and greater than -1 should have a zero digit on the left hand side of the decimal seperator, or not.
boolean	isNumberAlwaysShowIntegerPart()	Determine if floating point numbers less than 1 and greater than -1 should have a zero digit on the left hand side of the decimal seperator, or not.
void	setCurrencyAlwaysShowIntegerPart(boolean p_bAlwaysShowIntegerPart)	Determine if currency values less than 1 and greater than -1 should have a zero digit on the left hand side of the decimal seperator, or not.
void	setCurrencyDecimalSeparator(String p_strSeparator)	Set the currency decimal separator.
void	setCurrencyDigitSeparator(String p_strSeparator)	Set the currency digit separator.
void	setCurrencyFractionDigits(int p_iFractionDigits)	Set the number of fraction digits for currency values.
void	setDateFormat(String p_strDateFormat)	Set the date format string.
void	setDateTimeFormat(String p_strDateTimeFormat)	Set the date/time format string.
void	setFirstDayOfWeek(int p_iFirstDayOfWeek)	Set the first day of the week.
void	setIntegerDigitSeparator(String p_strSeparator)	Set the integer digit separator.
void	setLanguage(String p_strLang)	Set the language identifier.
void	setLongDateFormat(String p_strDateFormat)	Set the long date format string.
void	setNumberAlwaysShowIntegerPart(boolean p_bAlwaysShowIntegerPart)	Determine if floating point numbers less than 1 and greater than -1 should have a zero digit on the left hand side of the decimal seperator, or not.
void	setNumberDecimalSeparator(String p_strSeparator)	Set the number decimal separator.
void	setNumberDigitSeparator(String p_strSeparator)	Set the number digit separator.
void	setNumberFractionDigits(int p_iFractionDigits)	Set the number of fraction digits of floating point numbers.
void	setParam(String p_strName, String p_value)	Set a parameter.
void	setRoundingMode(RoundingMode p_roundingMode)	Set the rounding mode.
void	setShortDateFormat(String p_strDateFormat)	Set the short date format string.
void	setTimeFormat(String p_strTimeFormat)	Set the time format string.
void	setTimeZone(TimeZone p_tz)	Set the time zone.
void	setTimeZoneById(String p_strTimeZone)	Set the time zone by it's identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderingContext

public RenderingContext()

Method Detail

clone

public Object clone()

getParam

public Object getParam(String p_strName)

Description copied from interface: IRenderingContext

Get a parameter.

Specified by:

getParam in interface IRenderingContext

Parameters:

p_strName - The name of the parameter.

Returns:

The value of the parameter.

setParam

public void setParam(String p_strName,
                     String p_value)

Description copied from interface: IRenderingContext

Set a parameter.

Specified by:

setParam in interface IRenderingContext

Parameters:

p_strName - The name of the parameter.

p_value - The value of the parameter.

getLanguage

public String getLanguage()

Description copied from interface: IRenderingContext

Get the language identifier.

Specified by:

getLanguage in interface IRenderingContext

Returns:

The language identifier.

setLanguage

public void setLanguage(String p_strLang)

Description copied from interface: IRenderingContext

Set the language identifier.

Specified by:

setLanguage in interface IRenderingContext

Parameters:

p_strLang - The language identifier.

setRoundingMode

public void setRoundingMode(RoundingMode p_roundingMode)

Description copied from interface: IRenderingContext

Set the rounding mode.

Specified by:

setRoundingMode in interface IRenderingContext

Parameters:

p_roundingMode - The rounding mode.

getRoundingMode

public RoundingMode getRoundingMode()

Description copied from interface: IRenderingContext

Get the rounding mode.

Specified by:

getRoundingMode in interface IRenderingContext

Returns:

The rounding mode.

getTimeZone

public TimeZone getTimeZone()

Description copied from interface: IRenderingContext

Get the time zone.

Specified by:

getTimeZone in interface IRenderingContext

Returns:

The time zone.

setTimeZone

public void setTimeZone(TimeZone p_tz)

Description copied from interface: IRenderingContext

Set the time zone.

Specified by:

setTimeZone in interface IRenderingContext

Parameters:

p_tz - The time zone.

setTimeZoneById

public void setTimeZoneById(String p_strTimeZone)

Description copied from interface: IRenderingContext

Set the time zone by it's identifier.

Specified by:

setTimeZoneById in interface IRenderingContext

Parameters:

p_strTimeZone - The Java time zone identifier.

getDateTimeFormat

public String getDateTimeFormat()

Description copied from interface: IRenderingContext

Get the date/time format string.

Specified by:

getDateTimeFormat in interface IRenderingContext

Returns:

The date/time format string.

setDateTimeFormat

public void setDateTimeFormat(String p_strDateTimeFormat)

Description copied from interface: IRenderingContext

Set the date/time format string.

Specified by:

setDateTimeFormat in interface IRenderingContext

Parameters:

p_strDateTimeFormat - The date/time format string.

getDateFormat

public String getDateFormat()

Description copied from interface: IRenderingContext

Get the date format string.

Specified by:

getDateFormat in interface IRenderingContext

Returns:

The date format string.

setDateFormat

public void setDateFormat(String p_strDateFormat)

Description copied from interface: IRenderingContext

Set the date format string.

Specified by:

setDateFormat in interface IRenderingContext

Parameters:

p_strDateFormat - The date format string.

getShortDateFormat

public String getShortDateFormat()

Description copied from interface: IRenderingContext

Get the short date format string.

Specified by:

getShortDateFormat in interface IRenderingContext

Returns:

The short date format string.

setShortDateFormat

public void setShortDateFormat(String p_strDateFormat)

Description copied from interface: IRenderingContext

Set the short date format string.

Specified by:

setShortDateFormat in interface IRenderingContext

Parameters:

p_strDateFormat - The short date format string.

getLongDateFormat

public String getLongDateFormat()

Description copied from interface: IRenderingContext

Get the long date format string.

Specified by:

getLongDateFormat in interface IRenderingContext

Returns:

The long date format string.

setLongDateFormat

public void setLongDateFormat(String p_strDateFormat)

Description copied from interface: IRenderingContext

Set the long date format string.

Specified by:

setLongDateFormat in interface IRenderingContext

Parameters:

p_strDateFormat - The long date format string.

getTimeFormat

public String getTimeFormat()

Description copied from interface: IRenderingContext

Get the time format string.

Specified by:

getTimeFormat in interface IRenderingContext

Returns:

The time format string.

setTimeFormat

public void setTimeFormat(String p_strTimeFormat)

Description copied from interface: IRenderingContext

Set the time format string.

Specified by:

setTimeFormat in interface IRenderingContext

Parameters:

p_strTimeFormat - The time format string.

getNumberDecimalSeparator

public String getNumberDecimalSeparator()

Description copied from interface: IRenderingContext

Get the number decimal separator.

Specified by:

getNumberDecimalSeparator in interface IRenderingContext

Returns:

The number decimal separator.

setNumberDecimalSeparator

public void setNumberDecimalSeparator(String p_strSeparator)

Description copied from interface: IRenderingContext

Set the number decimal separator.

Specified by:

setNumberDecimalSeparator in interface IRenderingContext

Parameters:

p_strSeparator - The number decimal separator.

getNumberDigitSeparator

public String getNumberDigitSeparator()

Description copied from interface: IRenderingContext

Get the number digit separator.

Specified by:

getNumberDigitSeparator in interface IRenderingContext

Returns:

The number digit separator.

setNumberDigitSeparator

public void setNumberDigitSeparator(String p_strSeparator)

Description copied from interface: IRenderingContext

Set the number digit separator.

Specified by:

setNumberDigitSeparator in interface IRenderingContext

Parameters:

p_strSeparator - The number digit separator.

getIntegerDigitSeparator

public String getIntegerDigitSeparator()

Description copied from interface: IRenderingContext

Get the integer digit separator.

Specified by:

getIntegerDigitSeparator in interface IRenderingContext

Returns:

The Integer digit separator.

setIntegerDigitSeparator

public void setIntegerDigitSeparator(String p_strSeparator)

Description copied from interface: IRenderingContext

Set the integer digit separator.

Specified by:

setIntegerDigitSeparator in interface IRenderingContext

Parameters:

p_strSeparator - The number digit separator.

getNumberFractionDigits

public int getNumberFractionDigits()

Description copied from interface: IRenderingContext

Get the number of fraction digits of floating point numbers.

Specified by:

getNumberFractionDigits in interface IRenderingContext

Returns:

The number of fraction digits of floating point numbers.

setNumberFractionDigits

public void setNumberFractionDigits(int p_iFractionDigits)

Description copied from interface: IRenderingContext

Set the number of fraction digits of floating point numbers.

Specified by:

setNumberFractionDigits in interface IRenderingContext

Parameters:

p_iFractionDigits - The number of fraction digits of floating point numbers.

isNumberAlwaysShowIntegerPart

public boolean isNumberAlwaysShowIntegerPart()

Description copied from interface: IRenderingContext

Determine if floating point numbers less than 1 and greater than -1 should have a zero digit on the left hand side of the decimal seperator, or not.

Specified by:

isNumberAlwaysShowIntegerPart in interface IRenderingContext

setNumberAlwaysShowIntegerPart

public void setNumberAlwaysShowIntegerPart(boolean p_bAlwaysShowIntegerPart)

Description copied from interface: IRenderingContext

Determine if floating point numbers less than 1 and greater than -1 should have a zero digit on the left hand side of the decimal seperator, or not.

Specified by:

setNumberAlwaysShowIntegerPart in interface IRenderingContext

getCurrencyDecimalSeparator

public String getCurrencyDecimalSeparator()

Description copied from interface: IRenderingContext

Get the currency decimal separator.

Specified by:

getCurrencyDecimalSeparator in interface IRenderingContext

Returns:

The currency decimal separator.

setCurrencyDecimalSeparator

public void setCurrencyDecimalSeparator(String p_strSeparator)

Description copied from interface: IRenderingContext

Set the currency decimal separator.

Specified by:

setCurrencyDecimalSeparator in interface IRenderingContext

Parameters:

p_strSeparator - The currency decimal separator.

getCurrencyDigitSeparator

public String getCurrencyDigitSeparator()

Description copied from interface: IRenderingContext

Get the currency digit separator. It is used for seperating groups of digits, e.g. in steps of thousand

Specified by:

getCurrencyDigitSeparator in interface IRenderingContext

Returns:

The currency digit separator.

setCurrencyDigitSeparator

public void setCurrencyDigitSeparator(String p_strSeparator)

Description copied from interface: IRenderingContext

Set the currency digit separator. It is used for seperating groups of digits, e.g. in steps of thousand

Specified by:

setCurrencyDigitSeparator in interface IRenderingContext

Parameters:

p_strSeparator - The currency digit separator.

getCurrencyFractionDigits

public int getCurrencyFractionDigits()

Description copied from interface: IRenderingContext

Get the number of fraction digits for currency values.

Specified by:

getCurrencyFractionDigits in interface IRenderingContext

Returns:

The number of fraction digits for currency values.

setCurrencyFractionDigits

public void setCurrencyFractionDigits(int p_iFractionDigits)

Description copied from interface: IRenderingContext

Set the number of fraction digits for currency values.

Specified by:

setCurrencyFractionDigits in interface IRenderingContext

Parameters:

p_iFractionDigits - The number of fraction digits for currency values.

isCurrencyAlwaysShowIntegerPart

public boolean isCurrencyAlwaysShowIntegerPart()

Description copied from interface: IRenderingContext

Determine if currency values less than 1 and greater than -1 should have a zero digit on the left hand side of the decimal seperator, or not.

Specified by:

isCurrencyAlwaysShowIntegerPart in interface IRenderingContext

setCurrencyAlwaysShowIntegerPart

public void setCurrencyAlwaysShowIntegerPart(boolean p_bAlwaysShowIntegerPart)

Description copied from interface: IRenderingContext

Determine if currency values less than 1 and greater than -1 should have a zero digit on the left hand side of the decimal seperator, or not.

Specified by:

setCurrencyAlwaysShowIntegerPart in interface IRenderingContext

getFirstDayOfWeek

public int getFirstDayOfWeek()

Description copied from interface: IRenderingContext

Get the first day of the week.

Specified by:

getFirstDayOfWeek in interface IRenderingContext

Returns:

1 for Sunday, 2 for monday, ..., 7 for saturday.

setFirstDayOfWeek

public void setFirstDayOfWeek(int p_iFirstDayOfWeek)

Description copied from interface: IRenderingContext

Set the first day of the week.

Specified by:

setFirstDayOfWeek in interface IRenderingContext

Parameters:

p_iFirstDayOfWeek - The first day of the week; 1 for Sunday, 2 for monday, ..., 7 for saturday.