All Packages Class Hierarchy This Package Previous Next Index

Class org.jfouffa.jslider.TextHeader

java.lang.Object
   |
   +----org.jfouffa.jslider.Header
           |
           +----org.jfouffa.jslider.TextHeader

public abstract class TextHeader
extends Header
Defines a header storing text properties.


Constructor index

 o TextHeader()

Method index

 o getBackgroundColor()
Gets the background-color property.
 o getColor()
Gets the color property.
 o getFontFamily()
Gets the value of the font-family property.
 o getFontSize()
Returns the value of the font-size property.
 o getFontStyle()
Gets the value of the font-style property.
 o getFontWeight()
Gets the value of the font-weight property.
 o getTextDecoration()
Gets the value of the text-decoration.
 o save(TemplateLoader)
Saves this Header using the specified TemplateLoader.
 o setBackgroundColor(String)
Sets the background-color property to the specified value.
 o setColor(String)
Sets the foreground color to the specified color.
 o setFontFamily(String)
Sets the font-family property to the specified value.
 o setFontSize(String)
Sets the font-size property to the specified value.
 o setFontStyle(String)
Sets the font-style property to the specified value.
 o setFontWeight(String)
Sets the font-weight property to the specified value.
 o setProperties(TemplateLoader, String)
Sets the properties of this Header using the specified TemplateLoader.
 o setTextDecoration(String)
Sets the text-decoration property to the specified value.
 o update(HeaderEditor)
Updates this header with the specified editor.

Constructors

 o TextHeader
 public TextHeader()

Methods

 o setTextDecoration
 public void setTextDecoration(String textDecoration)
Sets the text-decoration property to the specified value.

Parameters:
textDecoration - none | underline | overline | line-through | blink
 o getTextDecoration
 public String getTextDecoration()
Gets the value of the text-decoration. The property is used to add underliningm overlining, strike-out or blinking effect on the text.

Allowed values : none | underline | overline | line-through | blink

 o getColor
 public String getColor()
Gets the color property.

 o setColor
 public void setColor(String color)
Sets the foreground color to the specified color.

Parameters:
color - the foreground color (RBG triplets or keywords)
 o setBackgroundColor
 public void setBackgroundColor(String backgroundColor)
Sets the background-color property to the specified value.

Parameters:
backgroundColor - transparent | <color> (RBG triplets or keywords)
 o getBackgroundColor
 public String getBackgroundColor()
Gets the background-color property.

 o getFontWeight
 public String getFontWeight()
Gets the value of the font-weight property. The font-weight is the weight of the desired font within the current family.

Allowed values : normal | bold | bolder | lighter | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900

 o getFontFamily
 public String getFontFamily()
Gets the value of the font-family property. The font-family is the font set used in your document. The font family returned could be generic names or familiar names.

 o getFontStyle
 public String getFontStyle()
Gets the value of the font-style property. The font-style lets you specify an oblique or italic style within the current font family.

Allowed values : normal | italic | oblique

 o getFontSize
 public String getFontSize()
Returns the value of the font-size property. The font-size property specified the size of the font.

 o setFontWeight
 public void setFontWeight(String fontWeight)
Sets the font-weight property to the specified value.

Parameters:
fontWeight - normal | bold | bolder | lighter | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900
 o setFontFamily
 public void setFontFamily(String fontFamily)
Sets the font-family property to the specified value.

Parameters:
fontFamily - a set of font family
 o setFontStyle
 public void setFontStyle(String fontStyle)
Sets the font-style property to the specified value.

Parameters:
fontStyle - normal | italic | oblique
 o setFontSize
 public void setFontSize(String fontSize)
Sets the font-size property to the specified value.

Parameters:
fontSize - the font size in points : <absolute size> | <relative size> | <length> | <percentage>
 o update
 public void update(HeaderEditor editor)
Updates this header with the specified editor.

Parameters:
editor - the editor that contains the new attributs for thsi header
Overrides:
update in class Header
 o setProperties
 public void setProperties(TemplateLoader loader,
                           String index)
Sets the properties of this Header using the specified TemplateLoader.

Parameters:
loader - the TemplateLoader
index - the index of this header (the string format)
Overrides:
setProperties in class Header
 o save
 public void save(TemplateLoader loader)
Saves this Header using the specified TemplateLoader.

Parameters:
loader - the template loader to use for saving
Overrides:
save in class Header