de.uplanet.lucy.server.renderer
Class RenderingContext

java.lang.Object
  extended by de.uplanet.lucy.server.renderer.RenderingContext
All Implemented Interfaces:
IRenderingContext, java.lang.Cloneable

public class RenderingContext
extends java.lang.Object
implements IRenderingContext, java.lang.Cloneable

Version:
$Revision: 76897 $

Constructor Summary
RenderingContext()
           
 
Method Summary
 java.lang.Object clone()
           
 java.lang.String getCurrencyDecimalSeparator()
          Get the currency decimal separator.
 java.lang.String getCurrencyDigitSeparator()
          Get the currency digit separator.
 int getCurrencyFractionDigits()
          Get the number of fraction digits for currency values.
 java.lang.String getDateFormat()
          Get the date format string.
 java.lang.String getDateTimeFormat()
          Get the date/time format string.
 int getFirstDayOfWeek()
          Get the first day of the week.
 java.lang.String getIntegerDigitSeparator()
          Get the integer digit separator.
 java.lang.String getLanguage()
          Get the language identifier.
 java.lang.String getLongDateFormat()
          Get the long date format string.
 java.lang.String getNumberDecimalSeparator()
          Get the number decimal separator.
 java.lang.String getNumberDigitSeparator()
          Get the number digit separator.
 int getNumberFractionDigits()
          Get the number of fraction digits of floating point numbers.
 java.lang.Object getParam(java.lang.String p_strName)
          Get a parameter.
 java.lang.String getShortDateFormat()
          Get the short date format string.
 java.lang.String getTimeFormat()
          Get the time format string.
 java.util.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(java.lang.String p_strSeparator)
          Set the currency decimal separator.
 void setCurrencyDigitSeparator(java.lang.String p_strSeparator)
          Set the currency digit separator.
 void setCurrencyFractionDigits(int p_iFractionDigits)
          Set the number of fraction digits for currency values.
 void setDateFormat(java.lang.String p_strDateFormat)
          Set the date format string.
 void setDateTimeFormat(java.lang.String p_strDateTimeFormat)
          Set the date/time format string.
 void setFirstDayOfWeek(int p_iFirstDayOfWeek)
          Set the first day of the week.
 void setIntegerDigitSeparator(java.lang.String p_strSeparator)
          Set the integer digit separator.
 void setLanguage(java.lang.String p_strLang)
          Set the language identifier.
 void setLongDateFormat(java.lang.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(java.lang.String p_strSeparator)
          Set the number decimal separator.
 void setNumberDigitSeparator(java.lang.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(java.lang.String p_strName, java.lang.String p_value)
          Set a parameter.
 void setShortDateFormat(java.lang.String p_strDateFormat)
          Set the short date format string.
 void setTimeFormat(java.lang.String p_strTimeFormat)
          Set the time format string.
 void setTimeZone(java.util.TimeZone p_tz)
          Set the time zone.
 void setTimeZoneById(java.lang.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 java.lang.Object clone()
Overrides:
clone in class java.lang.Object

getParam

public java.lang.Object getParam(java.lang.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(java.lang.String p_strName,
                     java.lang.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 java.lang.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(java.lang.String p_strLang)
Description copied from interface: IRenderingContext
Set the language identifier.

Specified by:
setLanguage in interface IRenderingContext
Parameters:
p_strLang - The language identifier.

getTimeZone

public java.util.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(java.util.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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.


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.