net.ruippeixotog.scalascraper.model.Element.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scala-scraper_3 Show documentation
scala-scraper
The newest version!
package net.ruippeixotog.scalascraper.model

/** A representation of a HTML DOM element.
  *
  * Elements can be obtained by obtaining [[Document]] instances (for example, through a
  * [[net.ruippeixotog.scalascraper.browser.Browser]]) and using one of its several methods. They provide several
  * methods for traversing and retrieving infomation from the DOM of the page in which they are.
  */
trait Element {

  /** The concrete type of this `Element`. Should be defined in each concrete implementation as its own type.
    */
  type ThisType <: Element

  /** The tag name of this element.
    */
  def tagName: String

  /** The element of this element.
    */
  def parent: Option[ThisType]

  /** The list of children of this element.
    */
  def children: Iterable[ThisType]

  /** The list of child nodes of this element.
    */
  def childNodes: Iterable[Node]

  /** The list of siblings of this element.
    */
  def siblings: Iterable[ThisType]

  /** The list of sibling nodes of this element.
    */
  def siblingNodes: Iterable[Node]

  /** The map of attributes of this element.
    */
  def attrs: Map[String, String]

  /** Checks if an attribute is defined in this element.
    * @param name
    *   the name of the attribute
    * @return
    *   `true` if the attribute is defined, `false` otherwise
    */
  def hasAttr(name: String): Boolean

  /** Returns the value associated with an attribute of this element.
    *
    * @param name
    *   the name of the attribute
    * @return
    *   the value associated with the given attribute.
    */
  def attr(name: String): String

  /** The text content inside this element and any child nodes.
    */
  def text: String

  /** The text content owned by this element only, i.e. without text inside children.
    */
  def ownText: String

  /** The HTML representation of the content inside this element as a string.
    */
  def innerHtml: String

  /** The HTML representation of this element as a string.
    */
  def outerHtml: String

  /** Executes a query on this element using a CSS selector.
    *
    * @param query
    *   the CSS selector used to select elements to be returned
    * @return
    *   an `ElementQuery` instance representing the sequence of resulting elements
    */
  def select(query: String): ElementQuery[ThisType]
}

object Element {
  type Strict[E <: Element] = Element { type ThisType = E }
  type Upper[E <: Element] = Element { type ThisType <: E }
}