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
-
TextHeader()
-
Method index
-
getBackgroundColor()
- Gets the background-color property.
-
getColor()
- Gets the color property.
-
getFontFamily()
- Gets the value of the font-family property.
-
getFontSize()
- Returns the value of the font-size property.
-
getFontStyle()
- Gets the value of the font-style property.
-
getFontWeight()
- Gets the value of the font-weight property.
-
getTextDecoration()
- Gets the value of the text-decoration.
-
save(TemplateLoader)
- Saves this Header using the specified TemplateLoader.
-
setBackgroundColor(String)
- Sets the background-color property to the specified value.
-
setColor(String)
- Sets the foreground color to the specified color.
-
setFontFamily(String)
- Sets the font-family property to the specified value.
-
setFontSize(String)
- Sets the font-size property to the specified value.
-
setFontStyle(String)
- Sets the font-style property to the specified value.
-
setFontWeight(String)
- Sets the font-weight property to the specified value.
-
setProperties(TemplateLoader, String)
- Sets the properties of this Header using the specified TemplateLoader.
-
setTextDecoration(String)
- Sets the text-decoration property to the specified value.
-
update(HeaderEditor)
- Updates this header with the specified editor.
Constructors
TextHeader
public TextHeader()
Methods
setTextDecoration
public void setTextDecoration(String textDecoration)
- Sets the text-decoration property to the specified value.
- Parameters:
- textDecoration - none | underline | overline | line-through | blink
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
getColor
public String getColor()
- Gets the color property.
setColor
public void setColor(String color)
- Sets the foreground color to the specified color.
- Parameters:
- color - the foreground color (RBG triplets or keywords)
setBackgroundColor
public void setBackgroundColor(String backgroundColor)
- Sets the background-color property to the specified value.
- Parameters:
- backgroundColor - transparent | <color> (RBG triplets or
keywords)
getBackgroundColor
public String getBackgroundColor()
- Gets the background-color property.
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
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.
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
getFontSize
public String getFontSize()
- Returns the value of the font-size property. The font-size
property specified the size of the font.
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
setFontFamily
public void setFontFamily(String fontFamily)
- Sets the font-family property to the specified value.
- Parameters:
- fontFamily - a set of font family
setFontStyle
public void setFontStyle(String fontStyle)
- Sets the font-style property to the specified value.
- Parameters:
- fontStyle - normal | italic | oblique
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>
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
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
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