Package com.webfirmframework.wffweb.css
Class BackgroundImage
java.lang.Object
com.webfirmframework.wffweb.css.core.AbstractCssProperty<BackgroundImage>
com.webfirmframework.wffweb.css.BackgroundImage
- All Implemented Interfaces:
CssProperty
,StateChangeInformer<Bean>
,Serializable
,Cloneable
public class BackgroundImage
extends AbstractCssProperty<BackgroundImage>
implements StateChangeInformer<Bean>
The background-image property sets one or more background images for an element. The background of an element is the total size of the element, including padding and border (but not the margin). By default, a background-image is placed at the top-left corner of an element, and repeated both vertically and horizontally. Tip: Always set a background-color to be used if the image is unavailable. Default value: none Inherited: no Animatable: no Version: CSS1 + new values in CSS3 JavaScript syntax: object.style.backgroundImage="url(smiley.gif)"
- Since:
- 1.0.0
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionthe default value isnone
BackgroundImage
(BackgroundImage backgroundImage) BackgroundImage
(UrlCss3Value... urlCss3Values) BackgroundImage
(String cssValue) BackgroundImage
(String... imageUrls) sample code :-new BackgroundImage("Test.gif", "TestImage.png")
createsbackground-image: url("Test.gif"), url("TestImage.png");
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
setCssValue
(String cssValue) void
setImageUrls
(UrlCss3Value... urlCss3Values) void
setImageUrls
(String... imageUrls) sample code :-backgroundImage.setImageUrls("Test.gif", "TestImage.png")
createsbackground-image: url("Test.gif"), url("TestImage.png");
.void
stateChanged
(Bean stateChangedObject) toString()
Methods inherited from class com.webfirmframework.wffweb.css.core.AbstractCssProperty
clone, getStateChangeInformer, isAlreadyInUse, setAlreadyInUse, setStateChangeInformer, toCssString
-
Field Details
-
INITIAL
- See Also:
-
INHERIT
- See Also:
-
NONE
- See Also:
-
-
Constructor Details
-
BackgroundImage
public BackgroundImage()the default value isnone
- Since:
- 1.0.0
-
BackgroundImage
- Parameters:
cssValue
- the cssValue to set. eg:-url(images/BackgroundDesign.png)
-
BackgroundImage
- Parameters:
backgroundImage
- theBackgroundImage
object from which the cssName and cssValue to set.
-
BackgroundImage
sample code :-new BackgroundImage("Test.gif", "TestImage.png")
createsbackground-image: url("Test.gif"), url("TestImage.png");
. For css3 syntax method please usenew BackgroundImage(UrlCss3Value... urlCss3Values)
orsetImageUrls(UrlCss3Value... urlCss3Values)
method.- Parameters:
imageUrls
- an array of backgroundImage urls, eg:-backgroundImage.setImageUrls("Test.gif", "TestImage.png")
and the generated css will bebackground-image: url("Test.gif"), url("TestImage.png");
- Since:
- 1.0.0
-
BackgroundImage
- Parameters:
urlCss3Values
- an array ofUrlCss3Value
objects.
-
-
Method Details
-
getCssName
- Specified by:
getCssName
in interfaceCssProperty
- Returns:
- the name portion in style, eg
align-content
for stylealign-content: center
.
-
getCssValue
- Specified by:
getCssValue
in interfaceCssProperty
- Returns:
- the value portion in style, eg
center
for stylealign-content: center
.
-
toString
-
setCssValue
- Specified by:
setCssValue
in classAbstractCssProperty<BackgroundImage>
- Parameters:
cssValue
-null
is considered as an invalid value.- Returns:
- the current object.
- Since:
- 1.0.0
-
setImageUrls
sample code :-backgroundImage.setImageUrls("Test.gif", "TestImage.png")
createsbackground-image: url("Test.gif"), url("TestImage.png");
. For css3 syntax method please usesetImageUrls(UrlCss3Value... urlCss3Values)
method.- Parameters:
imageUrls
- an array of backgroundImage urls, eg:-backgroundImage.setImageUrls("Test.gif", "TestImage.png")
and the generated css will bebackground-image: url("Test.gif"), url("TestImage.png");
- Since:
- 1.0.0
-
setImageUrls
- Parameters:
urlCss3Values
- urlCss3Values an array ofUrlCss3Value
objects.- Since:
- 1.0.0
-
getUrlCss3Values
- Returns:
- a new object of unmodifiable
List<UrlCss3Value>
whenever this method is called. Or null. - Since:
- 1.0.0
-
setAsInitial
public void setAsInitial()- Since:
- 1.0.0
-
setAsInherit
public void setAsInherit()- Since:
- 1.0.0
-
stateChanged
- Specified by:
stateChanged
in interfaceStateChangeInformer<Bean>
-