org.opencms.workplace
Class CmsWorkplaceCustomFoot

java.lang.Object
  org.opencms.workplace.CmsWorkplaceCustomFoot

public class CmsWorkplaceCustomFoot
extends java.lang.Object

A custom foot configuration to create a specially designed foot for the OpenCms workplace.

Since:

6.9.2

Version:

$Revision: 1.6 $

Author:

Andreas Zahner

Field Summary

static java.lang.String	DEFAUL_COLOR The default foot frame font color.
static java.lang.String	DEFAULT_BACKGROUNDCOLOR The default foot frame background color.
static java.lang.String	DEFAULT_TEXT The default workplace foot text to display.
static java.lang.String	DEFAULT_TEXT_WITH_OU The default workplace foot text to display.

Constructor Summary

CmsWorkplaceCustomFoot()
Empty constructor.

Method Summary

java.lang.String	getBackgroundColor() Returns the background color of the foot frame.
java.lang.String	getColor() Returns the font color of the foot frame.
java.lang.String	getText() Returns the additional text of the foot frame.
java.lang.String	getTextResolved(CmsWorkplace wp) Returns the text of the foot frame with resolved macros.
boolean	isReplaceDefault() Returns if the default text should be replaced or kept.
void	setBackgroundColor(java.lang.String backgroundColor) Sets the background color of the foot frame.
void	setColor(java.lang.String color) Sets the font color of the foot frame.
void	setText(java.lang.String text, java.lang.String replaceDefault) Sets the additional text of the foot frame.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAUL_COLOR

public static final java.lang.String DEFAUL_COLOR

The default foot frame font color.

See Also:

Constant Field Values

DEFAULT_BACKGROUNDCOLOR

public static final java.lang.String DEFAULT_BACKGROUNDCOLOR

The default foot frame background color.

See Also:

Constant Field Values

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT

The default workplace foot text to display.

See Also:

Constant Field Values

DEFAULT_TEXT_WITH_OU

public static final java.lang.String DEFAULT_TEXT_WITH_OU

The default workplace foot text to display.

See Also:

Constant Field Values

Constructor Detail

CmsWorkplaceCustomFoot

public CmsWorkplaceCustomFoot()

Empty constructor.

Method Detail

getBackgroundColor

public java.lang.String getBackgroundColor()

Returns the background color of the foot frame.

Returns:

the background color of the foot frame

getColor

public java.lang.String getColor()

Returns the font color of the foot frame.

Returns:

the font color of the foot frame

getText

public java.lang.String getText()

Returns the additional text of the foot frame.

Returns:

the additional text of the foot frame

getTextResolved

public java.lang.String getTextResolved(CmsWorkplace wp)

Returns the text of the foot frame with resolved macros.

Parameters:

wp - the initialized workplace dialog

Returns:

the text of the foot frame with resolved macros

isReplaceDefault

public boolean isReplaceDefault()

Returns if the default text should be replaced or kept.

Returns:

true if the default text should be replaced, otherwise false

setBackgroundColor

public void setBackgroundColor(java.lang.String backgroundColor)

Sets the background color of the foot frame.

Parameters:

backgroundColor - the background color of the foot frame

setColor

public void setColor(java.lang.String color)

Sets the font color of the foot frame.

Parameters:

color - the font color of the foot frame

setText

public void setText(java.lang.String text,
                    java.lang.String replaceDefault)

Sets the additional text of the foot frame.

Parameters:

text - the additional text of the foot frame

replaceDefault - flag indicating if the default text should be replaced or kept