org.apache.jetspeed.portal
Interface PortletSkin

All Superinterfaces:
java.util.Map
All Known Implementing Classes:
BasePortletSkin

public interface PortletSkin
extends java.util.Map

The PortletSkin defines the color scheme to use for displaying a specified portlet (and associated control)

Version:
$Id: PortletSkin.java,v 1.8 2005/03/21 18:21:41 sgala Exp $
Author:
RaphaŽl Luta, Paul Spencer, Scott T. Weaver

Nested Class Summary
 
Nested classes inherited from class java.util.Map
java.util.Map.Entry
 
Field Summary
static java.lang.String BACKGROUND_COLOR
           
static java.lang.String CONTENT_STYLE_CLASS
           
static java.lang.String CONTROLLER_STYLE_CLASS
           
static java.lang.String HIGHLIGHT_BACKGROUND_COLOR
           
static java.lang.String HIGHLIGHT_TEXT_COLOR
           
static java.lang.String HIGHLIGHT_TITLE_STYLE_CLASS
           
static java.lang.String PORTLET_SKIN_CLASS
           
static java.lang.String PORTLET_STYLE_CLASS
           
static java.lang.String TAB_CONTENT_STYLE_CLASS
           
static java.lang.String TAB_STYLE_CLASS
           
static java.lang.String TAB_TITLE_STYLE_CLASS
           
static java.lang.String TEXT_COLOR
           
static java.lang.String TITLE_BACKGROUND_COLOR
           
static java.lang.String TITLE_STYLE_CLASS
           
static java.lang.String TITLE_TEXT_COLOR
           
 
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 titles on 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()
          This returns the class to use for the entire portlet, based on the cascading : portlet has 9 possible class to be used in a skin : ________________ - title (+ left/right) |__|__________|__| | | | | | | | | - content (+ left/right) | | | | | | | | |__|__________|__| - bottom (+ left/right) |__|__________|__| using cascading, we can change all of those class with one parent class -> this is how PortletSkinClass is used
 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 backgroundColor)
          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 titleColor)
          Sets the color to use for displaying an highlighted background
 void setHighlightTextColor(java.lang.String titleColor)
          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 titles tab or menu item
 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 titleColor)
          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 titleColor)
          Sets the color to use for displaying the portlet title text
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Field Detail

TEXT_COLOR

public static final java.lang.String TEXT_COLOR
See Also:
Constant Field Values

BACKGROUND_COLOR

public static final java.lang.String BACKGROUND_COLOR
See Also:
Constant Field Values

TITLE_TEXT_COLOR

public static final java.lang.String TITLE_TEXT_COLOR
See Also:
Constant Field Values

TITLE_BACKGROUND_COLOR

public static final java.lang.String TITLE_BACKGROUND_COLOR
See Also:
Constant Field Values

HIGHLIGHT_TEXT_COLOR

public static final java.lang.String HIGHLIGHT_TEXT_COLOR
See Also:
Constant Field Values

HIGHLIGHT_BACKGROUND_COLOR

public static final java.lang.String HIGHLIGHT_BACKGROUND_COLOR
See Also:
Constant Field Values

CONTROLLER_STYLE_CLASS

public static final java.lang.String CONTROLLER_STYLE_CLASS
See Also:
Constant Field Values

PORTLET_STYLE_CLASS

public static final java.lang.String PORTLET_STYLE_CLASS
See Also:
Constant Field Values

TITLE_STYLE_CLASS

public static final java.lang.String TITLE_STYLE_CLASS
See Also:
Constant Field Values

CONTENT_STYLE_CLASS

public static final java.lang.String CONTENT_STYLE_CLASS
See Also:
Constant Field Values

HIGHLIGHT_TITLE_STYLE_CLASS

public static final java.lang.String HIGHLIGHT_TITLE_STYLE_CLASS
See Also:
Constant Field Values

TAB_STYLE_CLASS

public static final java.lang.String TAB_STYLE_CLASS
See Also:
Constant Field Values

TAB_TITLE_STYLE_CLASS

public static final java.lang.String TAB_TITLE_STYLE_CLASS
See Also:
Constant Field Values

TAB_CONTENT_STYLE_CLASS

public static final java.lang.String TAB_CONTENT_STYLE_CLASS
See Also:
Constant Field Values

PORTLET_SKIN_CLASS

public static final java.lang.String PORTLET_SKIN_CLASS
See Also:
Constant Field Values
Method Detail

getName

public java.lang.String getName()
Returns the name of this color scheme

Returns:
the color scheme name

getTextColor

public java.lang.String getTextColor()
Returns the color to use for displaying the portlet text

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

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

Returns:
the text color value in HTML format (#RRGGBB)

setBackgroundColor

public void setBackgroundColor(java.lang.String backgroundColor)
Sets the color to use for displaying the portlet background

Parameters:
backgroundColor - 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

Returns:
the text color value in HTML format (#RRGGBB)

setTitleTextColor

public void setTitleTextColor(java.lang.String titleColor)
Sets the color to use for displaying the portlet title text

Parameters:
titleColor - 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

Returns:
the background color value in HTML format (#RRGGBB)

setTitleBackgroundColor

public void setTitleBackgroundColor(java.lang.String titleColor)
Sets the color to use for displaying the portlet title background

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

getHighlightTextColor

public java.lang.String getHighlightTextColor()
Returns the color to use for displaying an highlighted text

Returns:
the text color value in HTML format (#RRGGBB)

setHighlightTextColor

public void setHighlightTextColor(java.lang.String titleColor)
Sets the color to use for displaying an highlighted text

Parameters:
titleColor - a color value in HTML format (#RRGGBB)

getHighlightBackgroundColor

public java.lang.String getHighlightBackgroundColor()
Returns the color to use for displaying an highlighted background

Returns:
the background color value in HTML format (#RRGGBB)

setHighlightBackgroundColor

public void setHighlightBackgroundColor(java.lang.String titleColor)
Sets the color to use for displaying an highlighted background

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

getPortletStyleClass

public java.lang.String getPortletStyleClass()
Returns the CSS class to use for the portlet overall

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

Parameters:
portletStyleClass - the new class to be used

getTitleStyleClass

public java.lang.String getTitleStyleClass()
Returns the CSS class to use for the portlet title

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

Parameters:
titleStyleClass - the new class to be used

getContentStyleClass

public java.lang.String getContentStyleClass()
Returns the CSS class to use for the portlet content

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

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

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

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

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

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

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

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 titles on tab or menu item

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 titles tab or menu item


getControllerStyleClass

public java.lang.String getControllerStyleClass()
Returns the CSS class to use for the Controller overall

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

Parameters:
controllerStyleClass - the new class to be used

getImage

public java.lang.String getImage(java.lang.String name,
                                 java.lang.String dftPath)
Returns a named image from this skin. The skin property must be prefixed with "image-" within the registry.

Returns:
String relative path to the image

setCapabilityMap

public void setCapabilityMap(CapabilityMap cm)
This allows the PortalToolKit to make the PortletSkin aware of the current user-agents's capabilities


getPortletSkinClass

public java.lang.String getPortletSkinClass()
This returns the class to use for the entire portlet, based on the cascading : portlet has 9 possible class to be used in a skin : ________________ - title (+ left/right) |__|__________|__| | | | | | | | | - content (+ left/right) | | | | | | | | |__|__________|__| - bottom (+ left/right) |__|__________|__| using cascading, we can change all of those class with one parent class -> this is how PortletSkinClass is used



Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.