Class BorderStyle


  • public class BorderStyle
    extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects a border style for a drawn shape's outline.</p>
     

    Java class for BorderStyle complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
     <complexType name="BorderStyle">
       <complexContent>
         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
           <attribute name="style" type="{http://www.w3.org/2001/XMLSchema}string" default="S" />
           <attribute name="width" default="1">
             <simpleType>
               <restriction base="{http://www.w3.org/2001/XMLSchema}float">
                 <minInclusive value="0"/>
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="dashPattern" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
           <attribute name="dashPhase" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
           <attribute name="effectStyle" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
           <attribute name="effectIntensity" type="{http://www.w3.org/2001/XMLSchema}float" default="0" />
           <attribute name="interiorColor" type="{http://schema.webpdf.de/1.0/extraction/info}RgbColorType" default="#4800FF" />
         </restriction>
       </complexContent>
     </complexType>
     
    • Field Detail

      • style

        protected String style
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The style of the shapes border.
                                 <ul><li>S = Solid</li><li>D = Dashed</li><li>B = Beveled</li><li>I = Inset</li><li>U = Underline</li></ul></p>
         
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                                 Further custom styles may be contained and shall default to a solid border if unknown.
                             </p>
         
      • width

        protected Float width
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The border width/line thickness in points.</p>
         
      • dashPattern

        protected String dashPattern
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The dash pattern (array) of a dashed border. The dash array contains the unit lengths of alternating dashes and gaps, that shall be cycled through along the length of the border.</p>
         
      • dashPhase

        protected Integer dashPhase
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The phase of the dash pattern.</p>
         
      • effectStyle

        protected String effectStyle
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The border effect to apply to the border shape.
                                 <ul><li>S = Apply no border effects.</li><li>C = Apply a cloud pattern to the border shape.</li></ul></p>
         
      • effectIntensity

        protected Float effectIntensity
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The intensity of a possibly set cloud effect, in a range from 0 to 2.</p>
         
      • interiorColor

        protected String interiorColor
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The interior (fill) color for the shape.</p>
         
    • Constructor Detail

      • BorderStyle

        public BorderStyle()
    • Method Detail

      • getStyle

        public String getStyle()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The style of the shapes border.
                                 <ul><li>S = Solid</li><li>D = Dashed</li><li>B = Beveled</li><li>I = Inset</li><li>U = Underline</li></ul></p>
         
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                                 Further custom styles may be contained and shall default to a solid border if unknown.
                             </p>
         
        Returns:
        possible object is String
      • setStyle

        public void setStyle​(String value)
        Sets the value of the style property.
        Parameters:
        value - allowed object is String
        See Also:
        getStyle()
      • getWidth

        public float getWidth()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The border width/line thickness in points.</p>
         
        Returns:
        possible object is Float
      • setWidth

        public void setWidth​(Float value)
        Sets the value of the width property.
        Parameters:
        value - allowed object is Float
        See Also:
        getWidth()
      • getDashPattern

        public String getDashPattern()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The dash pattern (array) of a dashed border. The dash array contains the unit lengths of alternating dashes and gaps, that shall be cycled through along the length of the border.</p>
         
        Returns:
        possible object is String
      • setDashPattern

        public void setDashPattern​(String value)
        Sets the value of the dashPattern property.
        Parameters:
        value - allowed object is String
        See Also:
        getDashPattern()
      • getDashPhase

        public int getDashPhase()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The phase of the dash pattern.</p>
         
        Returns:
        possible object is Integer
      • setDashPhase

        public void setDashPhase​(Integer value)
        Sets the value of the dashPhase property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getDashPhase()
      • getEffectStyle

        public String getEffectStyle()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The border effect to apply to the border shape.
                                 <ul><li>S = Apply no border effects.</li><li>C = Apply a cloud pattern to the border shape.</li></ul></p>
         
        Returns:
        possible object is String
      • setEffectStyle

        public void setEffectStyle​(String value)
        Sets the value of the effectStyle property.
        Parameters:
        value - allowed object is String
        See Also:
        getEffectStyle()
      • getEffectIntensity

        public float getEffectIntensity()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The intensity of a possibly set cloud effect, in a range from 0 to 2.</p>
         
        Returns:
        possible object is Float
      • setEffectIntensity

        public void setEffectIntensity​(Float value)
        Sets the value of the effectIntensity property.
        Parameters:
        value - allowed object is Float
        See Also:
        getEffectIntensity()
      • getInteriorColor

        public String getInteriorColor()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The interior (fill) color for the shape.</p>
         
        Returns:
        possible object is String
      • setInteriorColor

        public void setInteriorColor​(String value)
        Sets the value of the interiorColor property.
        Parameters:
        value - allowed object is String
        See Also:
        getInteriorColor()