org.richfaces.skin
Interface Skin

public interface Skin

Main interface for configurable parameters.

Version:

$Revision: 1.1.2.1 $ $Date: 2007/01/09 18:59:43 $

Author:

asmirnov@exadel.com (latest modification by $Author: alexsmirnov $)

Nested Class Summary

static interface

Skin.Preferable Preferable parameters names for skin ( in common, for Preferable.Name parameter will PreferableName )

Field Summary

static java.lang.String	activetabStyleFont Style of the text displaying on the active (selected) tabs.Default value normal.
static java.lang.String	activetabWeightFont Depth of the text displaying on the active (selected) tabs.Default value bold.
static java.lang.String	additionalBackgroundColor
static java.lang.String	baseSkin
static java.lang.String	buttonFamilyFont Font name for displaying buttons titles.
static java.lang.String	buttonRadiusCorner Rounding-off radius of the buttons corners.
static java.lang.String	buttonSizeFont Font size for displaying buttons titles.
static java.lang.String	buttonStyleFont Style of the text displaying on the button.
static java.lang.String	buttonWeightFont Depth of the text displaying on the button.
static java.lang.String	controlBackgroundColor
static java.lang.String	controlBorderColor Responsible for the borders color of the radiobutton and checkbox and color of light part of the fields and text area border.
static java.lang.String	disabledTabStyleFont Style of the text displaying on the disabled tabs.Default value normal.
static java.lang.String	disabledTabWeightFont Depth of the text displaying on the disabled tabs.Default value normal.
static java.lang.String	extendedStyleSheet used for define url with extended CSS file for current skin.
static java.lang.String	generalBackgroundColor used for defining the background color of the basic area of the panel and tabpanels, background color of the dropdown list boxes of ddmenu.
static java.lang.String	generalLinkColor
static java.lang.String	generalSizeFont
static java.lang.String	generalStyleSheet used for define url with general CSS file for current skin.
static java.lang.String	generalTextColor used for defining color of the basic text, color of the text in the dropdown list boxes of ddmenu, color of the right and top borders for the controls like text, textArea, secret.
static java.lang.String	gradientType
static java.lang.String	headerBackgroundColor used for defining a header background color in the panel, a tabpanel active tab background color, a bar background color for ddmenu, tables background color, buttons background color.
static java.lang.String	headerFamilyFont Font name for the displaying panels headers and top level of the ddmenu.Default value Arial, Verdana.
static java.lang.String	headerGradientColor
static java.lang.String	headerSizeFont Font size for the displaying panels headers and top level of the ddmenu.
static java.lang.String	headTextColor used for defining color of the titles of the top level of the menu, the panel header color, the table header color, color of the title of the active tab in the tabpanel, color of the title on the buttons.
static java.lang.String	interfaceLevel3D Parameter responsible for 3D Look of panels and buttons.
static java.lang.String	loadStyleSheets
static java.lang.String	overAllBackground
static java.lang.String	panelRadiusCorner Rounding-off radius of the panels corners.
static java.lang.String	panelTextColor
static java.lang.String	preferableTabPosition defines the layout of the tabs in the panel.
static java.lang.String	preferableTabTextDirection text aligning in the tabs with the fixed tab length (hight).
static java.lang.String	preferableTabTextOrientation defines the variant of text writing.
static java.lang.String	selectBackgroundColor used for defining the background color of the bar under the header in the panel and the tabpanel, color of the border for the top level of the ddmenu, background highlight color of the selected item in the dropdown list boxes of the ddmenu, background color of the footer in the tables, color of the text for the inactive and disabled tab in the tabpanel, color of the border of the buttons.
static java.lang.String	selectControlColor Color for selected checkbox or selectOneRadio.
static java.lang.String	shadowBackgroundColor used for defining shadow background color of the panels, color of the bottom and right borders for the dropdown list box in ddmenu.
static java.lang.String	shadowOpacity used for defining the seamlessness of the tip shadow.
static java.lang.String	tabFamilyFont Font name for displaying tab titles.
static java.lang.String	tableBackgroundColor used for defining tables and controls background color.
static java.lang.String	tableBorderColor used for defining tables border color, color of the bottom and left controls like text, textArea, secret, color of the top and left borders for the dropdown list box in the ddmenu.
static java.lang.String	tabRadiusCorner Rounding-off radius of the tabs corners.
static java.lang.String	tabSizeFont Font size for displaying tab titles.
static java.lang.String	tabStyleFont Style of of the text displaying on the inactive (unselected) tabs.
static java.lang.String	tabWeightFont Depth of the text displaying on the inactive (unselected) tabs.Default value normal.

Method Summary

boolean	containsProperty(java.lang.String name)
java.lang.Object	getParameter(javax.faces.context.FacesContext context, java.lang.String name) Get value for configuration parameter.
java.lang.Object	getParameter(javax.faces.context.FacesContext context, java.lang.String name, java.lang.Object defaultValue) Get value for configuration parameter.
java.lang.String	getRenderKitId(javax.faces.context.FacesContext context) Get Rener Kit name for this skin.
int	hashCode(javax.faces.context.FacesContext context) Calculate unique ( as possible ) code to identity this skin instance.

Field Detail

generalStyleSheet

static final java.lang.String generalStyleSheet

used for define url with general CSS file for current skin.

See Also:

Constant Field Values

extendedStyleSheet

static final java.lang.String extendedStyleSheet

used for define url with extended CSS file for current skin.

See Also:

Constant Field Values

headerBackgroundColor

static final java.lang.String headerBackgroundColor

used for defining a header background color in the panel, a tabpanel active tab background color, a bar background color for ddmenu, tables background color, buttons background color. Default value #1D7DB3.

See Also:

Constant Field Values

headTextColor

static final java.lang.String headTextColor

used for defining color of the titles of the top level of the menu, the panel header color, the table header color, color of the title of the active tab in the tabpanel, color of the title on the buttons. Default value #FFFFFF.

See Also:

Constant Field Values

selectBackgroundColor

static final java.lang.String selectBackgroundColor

used for defining the background color of the bar under the header in the panel and the tabpanel, color of the border for the top level of the ddmenu, background highlight color of the selected item in the dropdown list boxes of the ddmenu, background color of the footer in the tables, color of the text for the inactive and disabled tab in the tabpanel, color of the border of the buttons. Default value #BFD7E4.

See Also:

Constant Field Values

generalBackgroundColor

static final java.lang.String generalBackgroundColor

used for defining the background color of the basic area of the panel and tabpanels, background color of the dropdown list boxes of ddmenu. Default value #BFD7E4.

See Also:

Constant Field Values

generalTextColor

static final java.lang.String generalTextColor

used for defining color of the basic text, color of the text in the dropdown list boxes of ddmenu, color of the right and top borders for the controls like text, textArea, secret. Default value #000000.

See Also:

Constant Field Values

shadowBackgroundColor

static final java.lang.String shadowBackgroundColor

used for defining shadow background color of the panels, color of the bottom and right borders for the dropdown list box in ddmenu. Default value #AFB1B2.

See Also:

Constant Field Values

shadowOpacity

static final java.lang.String shadowOpacity

used for defining the seamlessness of the tip shadow. Default value 2.

See Also:

Constant Field Values

tableBorderColor

static final java.lang.String tableBorderColor

used for defining tables border color, color of the bottom and left controls like text, textArea, secret, color of the top and left borders for the dropdown list box in the ddmenu. Default value #CCCCCC.

See Also:

Constant Field Values

tableBackgroundColor

static final java.lang.String tableBackgroundColor

used for defining tables and controls background color. Default value #FFFFFF.

See Also:

Constant Field Values

headerSizeFont

static final java.lang.String headerSizeFont

Font size for the displaying panels headers and top level of the ddmenu. Default value 12px.

See Also:

Constant Field Values

headerFamilyFont

static final java.lang.String headerFamilyFont

Font name for the displaying panels headers and top level of the ddmenu.Default value Arial, Verdana.

See Also:

Constant Field Values

tabSizeFont

static final java.lang.String tabSizeFont

Font size for displaying tab titles. Default value 11px.

See Also:

Constant Field Values

tabFamilyFont

static final java.lang.String tabFamilyFont

Font name for displaying tab titles. Default value Arial, Verdana.

See Also:

Constant Field Values

tabRadiusCorner

static final java.lang.String tabRadiusCorner

Rounding-off radius of the tabs corners. Default value 5px.

See Also:

Constant Field Values

buttonSizeFont

static final java.lang.String buttonSizeFont

Font size for displaying buttons titles. Default value 11px.

See Also:

Constant Field Values

buttonFamilyFont

static final java.lang.String buttonFamilyFont

Font name for displaying buttons titles. Default value Arial, Verdana.

See Also:

Constant Field Values

buttonRadiusCorner

static final java.lang.String buttonRadiusCorner

Rounding-off radius of the buttons corners. Default value 13px.

See Also:

Constant Field Values

panelRadiusCorner

static final java.lang.String panelRadiusCorner

Rounding-off radius of the panels corners. Default value 5px.

See Also:

Constant Field Values

buttonStyleFont

static final java.lang.String buttonStyleFont

Style of the text displaying on the button. Default value normal.

See Also:

Constant Field Values

buttonWeightFont

static final java.lang.String buttonWeightFont

Depth of the text displaying on the button. Default value bold.

See Also:

Constant Field Values

activetabStyleFont

static final java.lang.String activetabStyleFont

Style of the text displaying on the active (selected) tabs.Default value normal.

See Also:

Constant Field Values

activetabWeightFont

static final java.lang.String activetabWeightFont

Depth of the text displaying on the active (selected) tabs.Default value bold.

See Also:

Constant Field Values

tabStyleFont

static final java.lang.String tabStyleFont

Style of of the text displaying on the inactive (unselected) tabs. Default value normal.

See Also:

Constant Field Values

tabWeightFont

static final java.lang.String tabWeightFont

Depth of the text displaying on the inactive (unselected) tabs.Default value normal.

See Also:

Constant Field Values

disabledTabStyleFont

static final java.lang.String disabledTabStyleFont

Style of the text displaying on the disabled tabs.Default value normal.

See Also:

Constant Field Values

disabledTabWeightFont

static final java.lang.String disabledTabWeightFont

Depth of the text displaying on the disabled tabs.Default value normal.

See Also:

Constant Field Values

selectControlColor

static final java.lang.String selectControlColor

Color for selected checkbox or selectOneRadio.

See Also:

Constant Field Values

controlBorderColor

static final java.lang.String controlBorderColor

Responsible for the borders color of the radiobutton and checkbox and color of light part of the fields and text area border. Default value #B0B0B0.

See Also:

Constant Field Values

interfaceLevel3D

static final java.lang.String interfaceLevel3D

Parameter responsible for 3D Look of panels and buttons.

See Also:

Constant Field Values

preferableTabPosition

static final java.lang.String preferableTabPosition

defines the layout of the tabs in the panel. Possible values Top. Left. Bottom, Right. Default value ???.

See Also:

Constant Field Values

preferableTabTextOrientation

static final java.lang.String preferableTabTextOrientation

defines the variant of text writing. Values - Hor (horisontal position), Vert (vertical position - letters are arranged into column), VertCW (vertical position with text rotation anticlockwise). Default value Hor.

See Also:

Constant Field Values

preferableTabTextDirection

static final java.lang.String preferableTabTextDirection

text aligning in the tabs with the fixed tab length (hight). Values Left, Center,Right for the horizontal oriented tabs, values Top, center, Bottom - for vertical oriented tabs. Default value center.

See Also:

Constant Field Values

overAllBackground

static final java.lang.String overAllBackground

See Also:

Constant Field Values

generalLinkColor

static final java.lang.String generalLinkColor

See Also:

Constant Field Values

panelTextColor

static final java.lang.String panelTextColor

See Also:

Constant Field Values

headerGradientColor

static final java.lang.String headerGradientColor

See Also:

Constant Field Values

additionalBackgroundColor

static final java.lang.String additionalBackgroundColor

See Also:

Constant Field Values

controlBackgroundColor

static final java.lang.String controlBackgroundColor

See Also:

Constant Field Values

generalSizeFont

static final java.lang.String generalSizeFont

See Also:

Constant Field Values

loadStyleSheets

static final java.lang.String loadStyleSheets

See Also:

Constant Field Values

gradientType

static final java.lang.String gradientType

See Also:

Constant Field Values

baseSkin

static final java.lang.String baseSkin

See Also:

Constant Field Values

Method Detail

getRenderKitId

java.lang.String getRenderKitId(javax.faces.context.FacesContext context)

Get Rener Kit name for this skin.

Parameters:

context - - FacesContext for current request. need for ValueBinding evaluation.

Returns:

RenderKitId for this skin, or null for default.

getParameter

java.lang.Object getParameter(javax.faces.context.FacesContext context,
                              java.lang.String name)

Get value for configuration parameter. If parameter set as EL-expression, calculate it value.

Parameters:

context - - FacesContext for current request.

name - name of paremeter.

Returns:

value of parameter in config, or null

getParameter

java.lang.Object getParameter(javax.faces.context.FacesContext context,
                              java.lang.String name,
                              java.lang.Object defaultValue)

Get value for configuration parameter. If parameter set as EL-expression, calculate it value.

Parameters:

context - - FacesContext for current request.

name - name of paremeter.

defaultValue - - default value if parameter not present in Skin

Returns:

value of parameter in config, or null

containsProperty

boolean containsProperty(java.lang.String name)

Parameters:

name -

Returns:

hashCode

int hashCode(javax.faces.context.FacesContext context)

Calculate unique ( as possible ) code to identity this skin instance. Used for generate hash key in skin-depended resources

Parameters:

context -

Returns: