Class OutlineOffset

  • All Implemented Interfaces:
    CssProperty, java.io.Serializable, java.lang.Cloneable


    public class OutlineOffset
    extends AbstractCssProperty<OutlineOffset>
     outline-offset: length|initial|inherit;
    
     The outline-offset property adds space between an outline and the edge or border of an element.
    
     Outlines differ from borders in two ways:
    
         An outline is a line drawn around elements, outside the border edge
         A outline do not take up space
         An outline may be non-rectangular
    
    
     Default value:  0
     Inherited:      no
     Animatable:     yes, see individual properties.
     Version:        CSS3
     JavaScript syntax:      object.style.outlineOffset="15px"
     
    Since:
    1.0.0
    See Also:
    Serialized Form
    • Constructor Detail

      • OutlineOffset

        public OutlineOffset​()
        The 0px will be set as the value
      • OutlineOffset

        public OutlineOffset​(java.lang.String cssValue)
        Parameters:
        cssValue - the css value to set.
      • OutlineOffset

        public OutlineOffset​(OutlineOffset outlineOffset)
        Parameters:
        outlineOffset - the OutlineOffset object from which the cssValue to set.And, null will throw NullValueException
      • OutlineOffset

        public OutlineOffset​(float percent)
        Parameters:
        percent - the percentage value to set. The cssLengthUnit will automatically set to %.
        Since:
        1.0.0
      • OutlineOffset

        public OutlineOffset​(float value,
                             CssLengthUnit cssLengthUnit)
        Parameters:
        value -
        cssLengthUnit -
    • Method Detail

      • setValue

        public OutlineOffset setValue​(float value,
                                      CssLengthUnit cssLengthUnit)
        Parameters:
        value -
        cssLengthUnit -
        Returns:
        the current object
        Since:
        1.0.0
      • setPercent

        public void setPercent​(float percent)
        Parameters:
        percent - the percent to set
        Since:
        1.0.0
      • getCssName

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

        public java.lang.String getCssValue​()
        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
      • getValue

        public java.lang.Float getValue​()
        gets the outline-offset in float value. OutlineOffset#getUnit() should be used to get the cssLengthUnit for this value.
        Returns:
        the value in float or null if the cssValue is initial or inherit.
        Since:
        1.0.0
      • getUnit

        public CssLengthUnit getUnit​()
        Returns:
        the cssLengthUnit PX/PER, or null if the value is any inbuilt value like inherit.
        Since:
        1.0.0
      • setCssValue

        public OutlineOffset setCssValue​(java.lang.String cssValue)
        Specified by:
        setCssValue in class AbstractCssProperty<OutlineOffset>
        Parameters:
        cssValue - the value should be in the format of 55px or 95%. null is considered as an invalid value and it will throw NullValueException.
        Returns:
        the current object.
        Since:
        1.0.0
      • setAsInitial

        public void setAsInitial​()
        sets as initial
        Since:
        1.0.0
      • setAsInherit

        public void setAsInherit​()
        sets as inherit
        Since:
        1.0.0