org.apache.jetspeed.portal
Class BasePortletSkin

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          org.apache.jetspeed.portal.BasePortletSkin

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map, PortletSkin, java.io.Serializable

public class BasePortletSkin

extends java.util.HashMap

implements PortletSkin

This default implementation of PortletSkin stores every property as a Map of text properties

Version:

$Id: BasePortletSkin.java,v 1.8 2005/03/21 18:21:41 sgala Exp $

Author:

Raphaël Luta, Paul Spencer, Scott T. Weaver

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

java.lang.String

name

Fields inherited from interface org.apache.jetspeed.portal.PortletSkin

BACKGROUND_COLOR, CONTENT_STYLE_CLASS, CONTROLLER_STYLE_CLASS, HIGHLIGHT_BACKGROUND_COLOR, HIGHLIGHT_TEXT_COLOR, HIGHLIGHT_TITLE_STYLE_CLASS, PORTLET_SKIN_CLASS, PORTLET_STYLE_CLASS, TAB_CONTENT_STYLE_CLASS, TAB_STYLE_CLASS, TAB_TITLE_STYLE_CLASS, TEXT_COLOR, TITLE_BACKGROUND_COLOR, TITLE_STYLE_CLASS, TITLE_TEXT_COLOR

Constructor Summary

BasePortletSkin()

Method Summary

java.lang.String	getBackgroundColor() Returns the color to use for displaying the portlet background
java.lang.String	getContentStyleClass() Returns the CSS class to use for the portlet content
java.lang.String	getControllerStyleClass() Returns the CSS class to use for the controller overall
java.lang.String	getHighlightBackgroundColor() Returns the color to use for displaying an highlighted background
java.lang.String	getHighlightTextColor() Returns the color to use for displaying an highlighted text
java.lang.String	getHighlightTitleStyleClass() Returns the CSS class to use on the control of the Highlighted title tab or menu item
java.lang.String	getImage(java.lang.String name, java.lang.String dftPath) Returns a named image from this skin.
java.lang.String	getName() Returns the name of this color scheme
java.lang.String	getPortletSkinClass() Returns the CSS class to use for the global skin rendering
java.lang.String	getPortletStyleClass() Returns the CSS class to use for the portlet overall
java.lang.String	getTabContentStyleClass() Returns the CSS class to use on the control of the tabbed control
java.lang.String	getTabStyleClass() Returns the CSS class to use overall for the tabbed control
java.lang.String	getTabTitleStyleClass() Returns the CSS class to use on the title of the tabbed control
java.lang.String	getTextColor() Returns the color to use for displaying the portlet text
java.lang.String	getTitleBackgroundColor() Returns the color to use for displaying the portlet title background
java.lang.String	getTitleStyleClass() Returns the CSS class to use for the portlet title
java.lang.String	getTitleTextColor() Returns the color to use for displaying the portlet title text
void	setBackgroundColor(java.lang.String color) Sets the color to use for displaying the portlet background
void	setCapabilityMap(CapabilityMap cm) This allows the PortalToolKit to make the PortletSkin aware of the current user-agents's capabilities
void	setContentStyleClass(java.lang.String contentStyleClass) Sets the CSS class to use for the portlet content
void	setControllerStyleClass(java.lang.String controllerStyleClass) Sets the CSS class to use for the controller overall
void	setHighlightBackgroundColor(java.lang.String color) Sets the color to use for displaying an highlighted background
void	setHighlightTextColor(java.lang.String color) Sets the color to use for displaying an highlighted text
void	setHighlightTitleStyleClass(java.lang.String highlightTitleStyleClass) Sets the CSS class to use on the control of the Highlighted title tab or menu item
void	setName(java.lang.String name) Sets the name of this Skin
void	setPortletSkinClass(java.lang.String portletSkinClass) Sets the CSS class to use for the global skin rendering
void	setPortletStyleClass(java.lang.String portletStyleClass) Sets the CSS class to use for the portlet overall
void	setTabContentStyleClass(java.lang.String tabContentStyleClass) Sets the CSS class to use on the control of the tabbed control
void	setTabStyleClass(java.lang.String tabStyleClass) Sets the CSS class to use for overall for the tabbed control
void	setTabTitleStyleClass(java.lang.String tabTitleStyleClass) Sets the CSS class to use on the title of the tabbed control
void	setTextColor(java.lang.String color) Sets the color to use for displaying the portlet text
void	setTitleBackgroundColor(java.lang.String color) Sets the color to use for displaying the portlet title background
void	setTitleStyleClass(java.lang.String titleStyleClass) Sets the CSS class to use for the portlet title
void	setTitleTextColor(java.lang.String color) Sets the color to use for displaying the portlet title text

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

name

public java.lang.String name

Constructor Detail

BasePortletSkin

public BasePortletSkin()

Method Detail

getName

public java.lang.String getName()

Returns the name of this color scheme

Specified by:

getName in interface PortletSkin

Returns:

the color scheme name

setName

public void setName(java.lang.String name)

Sets the name of this Skin

getTextColor

public java.lang.String getTextColor()

Returns the color to use for displaying the portlet text

Specified by:

getTextColor in interface PortletSkin

Returns:

the text color value in HTML format (#RRGGBB)

setTextColor

public void setTextColor(java.lang.String color)

Sets the color to use for displaying the portlet text

Specified by:

setTextColor in interface PortletSkin

Parameters:

color - the text color value in HTML format (#RRGGBB)

getBackgroundColor

public java.lang.String getBackgroundColor()

Returns the color to use for displaying the portlet background

Specified by:

getBackgroundColor in interface PortletSkin

Returns:

the text color value in HTML format (#RRGGBB)

setBackgroundColor

public void setBackgroundColor(java.lang.String color)

Sets the color to use for displaying the portlet background

Specified by:

setBackgroundColor in interface PortletSkin

Parameters:

color - the background color value in HTML format (#RRGGBB)

getTitleTextColor

public java.lang.String getTitleTextColor()

Returns the color to use for displaying the portlet title text

Specified by:

getTitleTextColor in interface PortletSkin

Returns:

the text color value in HTML format (#RRGGBB)

setTitleTextColor

public void setTitleTextColor(java.lang.String color)

Sets the color to use for displaying the portlet title text

Specified by:

setTitleTextColor in interface PortletSkin

Parameters:

color - the title color value in HTML format (#RRGGBB)

getTitleBackgroundColor

public java.lang.String getTitleBackgroundColor()

Returns the color to use for displaying the portlet title background

Specified by:

getTitleBackgroundColor in interface PortletSkin

Returns:

the background color value in HTML format (#RRGGBB)

setTitleBackgroundColor

public void setTitleBackgroundColor(java.lang.String color)

Sets the color to use for displaying the portlet title background

Specified by:

setTitleBackgroundColor in interface PortletSkin

Parameters:

color - the title color value in HTML format (#RRGGBB)

getHighlightTextColor

public java.lang.String getHighlightTextColor()

Returns the color to use for displaying an highlighted text

Specified by:

getHighlightTextColor in interface PortletSkin

Returns:

the text color value in HTML format (#RRGGBB)

setHighlightTextColor

public void setHighlightTextColor(java.lang.String color)

Sets the color to use for displaying an highlighted text

Specified by:

setHighlightTextColor in interface PortletSkin

Parameters:

color - a color value in HTML format (#RRGGBB)

getHighlightBackgroundColor

public java.lang.String getHighlightBackgroundColor()

Returns the color to use for displaying an highlighted background

Specified by:

getHighlightBackgroundColor in interface PortletSkin

Returns:

the background color value in HTML format (#RRGGBB)

setHighlightBackgroundColor

public void setHighlightBackgroundColor(java.lang.String color)

Sets the color to use for displaying an highlighted background

Specified by:

setHighlightBackgroundColor in interface PortletSkin

Parameters:

color - the title color value in HTML format (#RRGGBB)

getPortletStyleClass

public java.lang.String getPortletStyleClass()

Returns the CSS class to use for the portlet overall

Specified by:

getPortletStyleClass in interface PortletSkin

Returns:

the CSS class to use (PortletStyleClass)

setPortletStyleClass

public void setPortletStyleClass(java.lang.String portletStyleClass)

Sets the CSS class to use for the portlet overall

Specified by:

setPortletStyleClass in interface PortletSkin

Parameters:

portletStyleClass - the new class to be used

getTitleStyleClass

public java.lang.String getTitleStyleClass()

Returns the CSS class to use for the portlet title

Specified by:

getTitleStyleClass in interface PortletSkin

Returns:

the CSS class to use (TitleStyleClass)

setTitleStyleClass

public void setTitleStyleClass(java.lang.String titleStyleClass)

Sets the CSS class to use for the portlet title

Specified by:

setTitleStyleClass in interface PortletSkin

Parameters:

titleStyleClass - the new class to be used

getContentStyleClass

public java.lang.String getContentStyleClass()

Returns the CSS class to use for the portlet content

Specified by:

getContentStyleClass in interface PortletSkin

Returns:

the CSS class to use (ContentStyleClass)

setContentStyleClass

public void setContentStyleClass(java.lang.String contentStyleClass)

Sets the CSS class to use for the portlet content

Specified by:

setContentStyleClass in interface PortletSkin

Parameters:

contentStyleClass - the new class to be used

getTabStyleClass

public java.lang.String getTabStyleClass()

Returns the CSS class to use overall for the tabbed control

Specified by:

getTabStyleClass in interface PortletSkin

Returns:

the CSS class to use (TabStyleClass)

setTabStyleClass

public void setTabStyleClass(java.lang.String tabStyleClass)

Sets the CSS class to use for overall for the tabbed control

Specified by:

setTabStyleClass in interface PortletSkin

Parameters:

tabStyleClass - the new class to be used

getTabTitleStyleClass

public java.lang.String getTabTitleStyleClass()

Returns the CSS class to use on the title of the tabbed control

Specified by:

getTabTitleStyleClass in interface PortletSkin

Returns:

the CSS class to use (TabTitleStyleClass)

setTabTitleStyleClass

public void setTabTitleStyleClass(java.lang.String tabTitleStyleClass)

Sets the CSS class to use on the title of the tabbed control

Specified by:

setTabTitleStyleClass in interface PortletSkin

Parameters:

tabTitleStyleClass - the new class to be used

getTabContentStyleClass

public java.lang.String getTabContentStyleClass()

Returns the CSS class to use on the control of the tabbed control

Specified by:

getTabContentStyleClass in interface PortletSkin

Returns:

the CSS class to use (TabContentStyleClass)

setTabContentStyleClass

public void setTabContentStyleClass(java.lang.String tabContentStyleClass)

Sets the CSS class to use on the control of the tabbed control

Specified by:

setTabContentStyleClass in interface PortletSkin

Parameters:

tabContentStyleClass - the new class to be used

getHighlightTitleStyleClass

public java.lang.String getHighlightTitleStyleClass()

Returns the CSS class to use on the control of the Highlighted title tab or menu item

Specified by:

getHighlightTitleStyleClass in interface PortletSkin

Returns:

the CSS class to use (HighlightTitleStyleClass)

setHighlightTitleStyleClass

public void setHighlightTitleStyleClass(java.lang.String highlightTitleStyleClass)

Sets the CSS class to use on the control of the Highlighted title tab or menu item

Specified by:

setHighlightTitleStyleClass in interface PortletSkin

Parameters:

highlightTitleStyleClass - the new class to be used

getControllerStyleClass

public java.lang.String getControllerStyleClass()

Returns the CSS class to use for the controller overall

Specified by:

getControllerStyleClass in interface PortletSkin

Returns:

the CSS class to use (ControllerStyleClass)

setControllerStyleClass

public void setControllerStyleClass(java.lang.String controllerStyleClass)

Sets the CSS class to use for the controller overall

Specified by:

setControllerStyleClass in interface PortletSkin

Parameters:

controllerStyleClass - the new class to be used

getPortletSkinClass

public java.lang.String getPortletSkinClass()

Returns the CSS class to use for the global skin rendering

Specified by:

getPortletSkinClass in interface PortletSkin

See Also:

PortletSkin.getPortletSkinClass()

setPortletSkinClass

public void setPortletSkinClass(java.lang.String portletSkinClass)

Sets the CSS class to use for the global skin rendering

Parameters:

portletSkinClass - the new class to be used

getImage

public java.lang.String getImage(java.lang.String name,
                                 java.lang.String dftPath)

Description copied from interface: PortletSkin

Returns a named image from this skin. The skin property must be prefixed with "image-" within the registry.

Specified by:

getImage in interface PortletSkin

Returns:

String relative path to the image

See Also:

PortletSkin.getImage(String, String)

setCapabilityMap

public void setCapabilityMap(CapabilityMap cm)

This allows the PortalToolKit to make the PortletSkin aware of the current user-agents's capabilities

Specified by:

setCapabilityMap in interface PortletSkin