Class DocumentHyperlinkBehaviour

java.lang.Object
org.apache.maven.doxia.document.DocumentHyperlinkBehaviour
All Implemented Interfaces:
Serializable

public class DocumentHyperlinkBehaviour extends Object implements Serializable
Specifies the default behavior for hyperlinks in the document.
Version:
$Revision$ $Date$
See Also:
  • Field Details

    • targetFrame

      private String targetFrame
      The name of the default target frame.

      Specifies the name of the default target frame in which to display a document referenced by a hyperlink.

      This attribute can have one of the following values:

      _self
      The referenced document replaces the content of the current frame.
      _blank
      The referenced document is displayed in a new frame.
      _parent
      The referenced document is displayed in the parent frame of the current frame.
      _top
      The referenced document is displayed in the topmost frame, that is the frame that contains the current frame as a child or descendent but is not contained within another frame.
      A frame name
      The referenced document is displayed in the named frame. If the named frame does not exist, a new frame with that name is created.
  • Constructor Details

    • DocumentHyperlinkBehaviour

      public DocumentHyperlinkBehaviour()
  • Method Details

    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      Returns:
      boolean
    • getTargetFrame

      public String getTargetFrame()
      Get the name of the default target frame.

      Specifies the name of the default target frame in which to display a document referenced by a hyperlink.

      This attribute can have one of the following values:

      _self
      The referenced document replaces the content of the current frame.
      _blank
      The referenced document is displayed in a new frame.
      _parent
      The referenced document is displayed in the parent frame of the current frame.
      _top
      The referenced document is displayed in the topmost frame, that is the frame that contains the current frame as a child or descendent but is not contained within another frame.
      A frame name
      The referenced document is displayed in the named frame. If the named frame does not exist, a new frame with that name is created.
      Returns:
      String
    • hashCode

      public int hashCode()
      Method hashCode.
      Overrides:
      hashCode in class Object
      Returns:
      int
    • setTargetFrame

      public void setTargetFrame(String targetFrame)
      Set the name of the default target frame.

      Specifies the name of the default target frame in which to display a document referenced by a hyperlink.

      This attribute can have one of the following values:

      _self
      The referenced document replaces the content of the current frame.
      _blank
      The referenced document is displayed in a new frame.
      _parent
      The referenced document is displayed in the parent frame of the current frame.
      _top
      The referenced document is displayed in the topmost frame, that is the frame that contains the current frame as a child or descendent but is not contained within another frame.
      A frame name
      The referenced document is displayed in the named frame. If the named frame does not exist, a new frame with that name is created.
      Parameters:
      targetFrame - a targetFrame object.
    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String