Module flying.saucer
Package org.xhtmlrenderer.extend

Interface NamespaceHandler

All Known Implementing Classes:
NoNamespaceHandler, XhtmlCssOnlyNamespaceHandler, XhtmlNamespaceHandler
public interface NamespaceHandler
Provides knowledge specific to a certain document type, like resolving style-sheets
Author:
Torbjoern Gannholm

  • Method Details

    • getNamespace

      @CheckReturnValue String getNamespace()

    • getDefaultStylesheet

      @CheckReturnValue Optional<StylesheetInfo> getDefaultStylesheet()

    • getDocumentTitle

      @CheckReturnValue @Nullable String getDocumentTitle(Document doc)

    • getStylesheets

      @CheckReturnValue List<StylesheetInfo> getStylesheets(Document doc)
      Parameters:
      doc - the document
      Returns:
      all links to CSS stylesheets (type="text/css") in this document

    • getAttributeValue

      @CheckReturnValue String getAttributeValue(Element e, String attrName)
      may return null. Required to return null if attribute does not exist and not null if attribute exists.

    • getAttributeValue

      @CheckReturnValue String getAttributeValue(Element e, @Nullable String namespaceURI, String attrName)

    • getClass

      @CheckReturnValue @Nullable String getClass(Element e)

    • getID

      @CheckReturnValue @Nullable String getID(Element e)

    • getElementStyling

      @CheckReturnValue @Nullable String getElementStyling(Element e)

    • getNonCssStyling

      @CheckReturnValue @Nullable String getNonCssStyling(Element e)
      Returns:
      The corresponding css properties for styling that is obtained in other ways.

    • getLang

      @CheckReturnValue String getLang(Element e)

    • getLinkUri

      @CheckReturnValue @Nullable String getLinkUri(Element e)
      should return null if element is not a link

    • getAnchorName

      @CheckReturnValue @Nullable String getAnchorName(@Nullable Element e)

    • isImageElement

      @CheckReturnValue boolean isImageElement(Element e)
      Returns:
      Returns true if the Element represents an image.

    • isFormElement

      @CheckReturnValue boolean isFormElement(Element e)
      Determines whether the specified Element represents a <form>.
      Parameters:
      e - The Element to evaluate.
      Returns:
      true if the Element is a <form> element, false otherwise.

    • getImageSourceURI

      @CheckReturnValue @Nullable String getImageSourceURI(Element e)
      For an element where isImageElement returns true, retrieves the URI associated with that Image, as reported by the element; makes no guarantee that the URI is correct, complete or points to anything in particular. For elements where isImageElement(Element) returns false, this method may return false, and may also return false if the Element is not correctly formed and contains no URI; check the return value carefully.
      Parameters:
      e - The element to extract image info from.
      Returns:
      String containing the URI for the image.