org.apache.myfaces.trinidad.skin
Class SkinAddition

java.lang.Object
  extended by org.apache.myfaces.trinidad.skin.SkinAddition

public class SkinAddition
extends java.lang.Object

SkinAdditions are defined in trinidad-skins.xml file <skin-addition> They are used by custom component developers who have created custom components, and they need a way to 'push' in their own stylesheet and resource bundle for these components into some skin of their choosing, most likely the simple skin. Skin objects contain zero or more SkinAdditions. The SkinAdditions' stylesheets are merged into the Skin's own stylesheet. The SkinAdditions' resource bundle is looked at along with the Skin's own resource bundle when Skin's getTranslatedValue is called.


Constructor Summary
SkinAddition(java.lang.String styleSheetName)
          Constructor takes a styleSheet name.
SkinAddition(java.lang.String styleSheetName, java.lang.String resourceBundleName)
          Constructor takes a styleSheet name and a resourceBundle name.
SkinAddition(java.lang.String styleSheetName, javax.faces.el.ValueBinding translationSourceValueBinding)
          Constructor takes a styleSheet name and a translationSource ValueBinding.
 
Method Summary
 java.lang.String getResourceBundleName()
          Gets the SkinAddition's resource bundle.
 java.lang.String getStyleSheetName()
          Gets the SkinAddition's style sheet name.
 javax.faces.el.ValueBinding getTranslationSourceValueBinding()
          Gets the SkinAddition's translation source ValueBinding.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SkinAddition

public SkinAddition(java.lang.String styleSheetName,
                    java.lang.String resourceBundleName)
Constructor takes a styleSheet name and a resourceBundle name.


SkinAddition

public SkinAddition(java.lang.String styleSheetName,
                    javax.faces.el.ValueBinding translationSourceValueBinding)
Constructor takes a styleSheet name and a translationSource ValueBinding.


SkinAddition

public SkinAddition(java.lang.String styleSheetName)
Constructor takes a styleSheet name. resource bundle name and translation source value binding will be null.

Method Detail

getStyleSheetName

public java.lang.String getStyleSheetName()
Gets the SkinAddition's style sheet name.


getResourceBundleName

public java.lang.String getResourceBundleName()
Gets the SkinAddition's resource bundle. Note: A skin cannot have both a resourceBundleName and a translation source value binding. If they do, then the resourceBundleName takes precedence.


getTranslationSourceValueBinding

public javax.faces.el.ValueBinding getTranslationSourceValueBinding()
Gets the SkinAddition's translation source ValueBinding. The ValueBinding can point to a Map or a ResourceBundle. Note: A skin cannot have both a resourceBundleName and a translation source value binding. If they do, then the resourceBundleName takes precedence.



Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.