Module com.github.librepdf.openpdf
Package com.lowagie.text.html.simpleparser

Class HTMLWorker

java.lang.Object
com.lowagie.text.html.simpleparser.HTMLWorker
All Implemented Interfaces:
DocListener, ElementListener, SimpleXMLDocHandler, AutoCloseable, EventListener
@Deprecated(since="2.1.0") public class HTMLWorker extends Object implements SimpleXMLDocHandler, DocListener
Deprecated.
This class is a simple parser for HTML. Security consideration: This method accepts input and processes it without built-in validation, filtering, or access restrictions. It may load resources such as local files or external URLs, depending on the input. This can introduce security risks including unauthorized file access, directory traversal, or server-side request forgery (SSRF). It is the responsibility of the calling application to validate and sanitize all input before passing it to this method, especially when handling user-controlled or external data. Refer to established secure coding guidelines to ensure safe usage.

  • Field Details

  • Constructor Details

    • HTMLWorker

      public HTMLWorker(DocListener document)
      Deprecated.
      Creates a new instance of HTMLWorker
      Parameters:
      document - A class that implements DocListener

  • Method Details

    • parseToList

      public static ArrayList<Element> parseToList(Reader reader, StyleSheet style) throws IOException
      Deprecated.
      Throws:
      IOException

    • parseToList

      public static ArrayList<Element> parseToList(Reader reader, StyleSheet style, Map<String,Object> interfaceProps) throws IOException
      Deprecated.
      Parses the HTML document and returns a list of elements. Security consideration: This method accepts input and processes it without built-in validation, filtering, or access restrictions. It may load resources such as local files or external URLs, depending on the input. This can introduce security risks including unauthorized file access, directory traversal, or server-side request forgery (SSRF). It is the responsibility of the calling application to validate and sanitize all input before passing it to this method, especially when handling user-controlled or external data. Refer to established secure coding guidelines to ensure safe usage.
      Parameters:
      reader -
      style -
      interfaceProps -
      Returns:
      Throws:
      IOException

    • getStyleSheet

      public StyleSheet getStyleSheet()
      Deprecated.

    • setStyleSheet

      public void setStyleSheet(StyleSheet style)
      Deprecated.

    • getInterfaceProps

      public Map<String,Object> getInterfaceProps()
      Deprecated.

    • setInterfaceProps

      public void setInterfaceProps(Map<String,Object> interfaceProps)
      Deprecated.

    • parse

      public void parse(Reader reader) throws IOException
      Deprecated.
      Parses the HTML document. Security consideration: This method accepts input and processes it without built-in validation, filtering, or access restrictions. It may load resources such as local files or external URLs, depending on the input. This can introduce security risks including unauthorized file access, directory traversal, or server-side request forgery (SSRF). It is the responsibility of the calling application to validate and sanitize all input before passing it to this method, especially when handling user-controlled or external data. Refer to established secure coding guidelines to ensure safe usage.
      Parameters:
      reader -
      Throws:
      IOException

    • endDocument

      public void endDocument()
      Deprecated.
      Description copied from interface: SimpleXMLDocHandler
      Called after the document is parsed.
      Specified by:
      endDocument in interface SimpleXMLDocHandler

    • startDocument

      public void startDocument()
      Deprecated.
      Description copied from interface: SimpleXMLDocHandler
      Called when the document starts to be parsed.
      Specified by:
      startDocument in interface SimpleXMLDocHandler

    • startElement

      public void startElement(String tag, Map<String,String> style)
      Deprecated.
      Description copied from interface: SimpleXMLDocHandler
      Called when a start tag is found.
      Specified by:
      startElement in interface SimpleXMLDocHandler
      Parameters:
      tag - the tag name
      style - the tag's attributes

    • endElement

      public void endElement(String tag)
      Deprecated.
      Description copied from interface: SimpleXMLDocHandler
      Called when an end tag is found.
      Specified by:
      endElement in interface SimpleXMLDocHandler
      Parameters:
      tag - the tag name

    • text

      public void text(String str)
      Deprecated.
      Description copied from interface: SimpleXMLDocHandler
      Called when a text element is found.
      Specified by:
      text in interface SimpleXMLDocHandler
      Parameters:
      str - the text element, probably a fragment.

    • add

      public boolean add(Element element) throws DocumentException
      Deprecated.
      Description copied from interface: ElementListener
      Signals that an Element was added to the Document.
      Specified by:
      add in interface ElementListener
      Parameters:
      element - a high level object
      Returns:
      true if the element was added, false if not.
      Throws:
      DocumentException - when a document isn't open yet, or has been closed

    • clearTextWrap

      public void clearTextWrap() throws DocumentException
      Deprecated.
      Throws:
      DocumentException

    • close

      public void close()
      Deprecated.
      Description copied from interface: DocListener
      Signals that the Document was closed and that no other Elements will be added.

      The outputstream of every writer implementing DocListener will be closed.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface DocListener

    • newPage

      public boolean newPage()
      Deprecated.
      Description copied from interface: DocListener
      Signals that an new page has to be started.
      Specified by:
      newPage in interface DocListener
      Returns:
      true if the page was added, false if not.

    • open

      public void open()
      Deprecated.
      Description copied from interface: DocListener
      Signals that the Document has been opened and that Elements can be added.
      Specified by:
      open in interface DocListener

    • resetFooter

      public void resetFooter()
      Deprecated.
      Description copied from interface: DocListener
      Resets the footer of this document.
      Specified by:
      resetFooter in interface DocListener

    • resetHeader

      public void resetHeader()
      Deprecated.
      Description copied from interface: DocListener
      Resets the header of this document.
      Specified by:
      resetHeader in interface DocListener

    • resetPageCount

      public void resetPageCount()
      Deprecated.
      Description copied from interface: DocListener
      Sets the page number to 0.
      Specified by:
      resetPageCount in interface DocListener

    • setFooter

      public void setFooter(HeaderFooter footer)
      Deprecated.
      Description copied from interface: DocListener
      Changes the footer of this document.
      Specified by:
      setFooter in interface DocListener
      Parameters:
      footer - the new footer

    • setHeader

      public void setHeader(HeaderFooter header)
      Deprecated.
      Description copied from interface: DocListener
      Changes the header of this document.
      Specified by:
      setHeader in interface DocListener
      Parameters:
      header - the new header

    • setMarginMirroring

      public boolean setMarginMirroring(boolean marginMirroring)
      Deprecated.
      Description copied from interface: DocListener
      Allows you to do left/right margin mirroring (odd/even pages)
      Specified by:
      setMarginMirroring in interface DocListener
      Parameters:
      marginMirroring - left/right margin mirroring (odd/even pages)
      Returns:
      true if successful

    • setMarginMirroringTopBottom

      public boolean setMarginMirroringTopBottom(boolean marginMirroring)
      Deprecated.
      Description copied from interface: DocListener
      Parameter that allows you to do top/bottom margin mirroring (odd/even pages)
      Specified by:
      setMarginMirroringTopBottom in interface DocListener
      Parameters:
      marginMirroring - top/bottom margin mirroring (odd/even pages)
      Returns:
      true if successful
      Since:
      2.1.6
      See Also:

    • setMargins

      public boolean setMargins(float marginLeft, float marginRight, float marginTop, float marginBottom)
      Deprecated.
      Description copied from interface: DocListener
      Sets the margins.
      Specified by:
      setMargins in interface DocListener
      Parameters:
      marginLeft - the margin on the left
      marginRight - the margin on the right
      marginTop - the margin on the top
      marginBottom - the margin on the bottom
      Returns:
      a boolean

    • setPageCount

      public void setPageCount(int pageN)
      Deprecated.
      Description copied from interface: DocListener
      Sets the page number.
      Specified by:
      setPageCount in interface DocListener
      Parameters:
      pageN - the new page number

    • setPageSize

      public boolean setPageSize(Rectangle pageSize)
      Deprecated.
      Description copied from interface: DocListener
      Sets the pagesize.
      Specified by:
      setPageSize in interface DocListener
      Parameters:
      pageSize - the new pagesize
      Returns:
      a boolean