Class Icon

  • All Implemented Interfaces:
    CssProperty, StateChangeInformer<Bean>, java.io.Serializable, java.lang.Cloneable


    public class Icon
    extends AbstractCssProperty<Icon>
    implements StateChangeInformer<Bean>
     icon: auto|URL|initial|inherit;
    
     The icon property provides the author the ability to style an element with an iconic equivalent.
    
     Note: An element's icon is not used unless the "content" property is set to the value "icon"!
     Default value:  auto
     Inherited:      no
     Animatable:     no
     Version:        CSS3
     JavaScript syntax:      object.style.icon="url(image.png)"
     
    Since:
    1.0.0
    See Also:
    Serialized Form
    • Constructor Detail

      • Icon

        public Icon​()
        the default value is none
        Since:
        1.0.0
      • Icon

        public Icon​(java.lang.String cssValue)
        Parameters:
        cssValue - the cssValue to set.
        eg:- url(images/BackgroundDesign.png)
      • Icon

        public Icon​(Icon icon)
        Parameters:
        icon - the Icon object from which the cssName and cssValue to set.
      • Icon

        public Icon​(java.lang.String... imageUrls)
        sample code :- new Icon("Test.gif", "TestImage.png") creates background-image: url("Test.gif"), url("TestImage.png"); . For css3 syntax method please use new Icon(UrlCss3Value... urlCss3Values) or setImageUrls(UrlCss3Value... urlCss3Values) method.
        Parameters:
        imageUrls - an array of icon urls, eg:- icon.setImageUrls("Test.gif", "TestImage.png") and the generated css will be background-image: url("Test.gif"), url("TestImage.png");
        Since:
        1.0.0
      • Icon

        public Icon​(UrlCss3Value... urlCss3Values)
        Parameters:
        urlCss3Values - an array of UrlCss3Value objects.
    • Method Detail

      • getCssName

        public java.lang.String getCssName​()
        Specified by:
        getCssName in interface CssProperty
        Returns:
        the name portion in style, eg align-content for style align-content: center.
      • getCssValue

        public java.lang.String getCssValue​()
        Specified by:
        getCssValue in interface CssProperty
        Returns:
        the value portion in style, eg center for style align-content: center.
      • toString

        public java.lang.String toString​()
        Overrides:
        toString in class java.lang.Object
      • setCssValue

        public Icon setCssValue​(java.lang.String cssValue)
        Specified by:
        setCssValue in class AbstractCssProperty<Icon>
        Parameters:
        cssValue - null is considered as an invalid value.
        Returns:
        the current object.
        Since:
        1.0.0
      • setImageUrls

        public void setImageUrls​(java.lang.String... imageUrls)
        sample code :- icon.setImageUrls("Test.gif", "TestImage.png") creates background-image: url("Test.gif"), url("TestImage.png");. For css3 syntax method please use setImageUrls(UrlCss3Value... urlCss3Values) method.
        Parameters:
        imageUrls - an array of icon urls, eg:- icon.setImageUrls("Test.gif", "TestImage.png") and the generated css will be background-image: url("Test.gif"), url("TestImage.png");
        Since:
        1.0.0
      • setImageUrls

        public void setImageUrls​(UrlCss3Value... urlCss3Values)
        Parameters:
        urlCss3Values - urlCss3Values an array of UrlCss3Value objects.
        Since:
        1.0.0
      • getUrlCss3Values

        public java.util.List<UrlCss3Value> 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