Package org.apache.maven.doxia.document
Class DocumentHyperlinkBehaviour
java.lang.Object
org.apache.maven.doxia.document.DocumentHyperlinkBehaviour
- All Implemented Interfaces:
Serializable
Specifies the default behavior for hyperlinks in the document.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Method equals.Get the name of the default target frame.int
hashCode()
Method hashCode.void
setTargetFrame
(String targetFrame) Set the name of the default target frame.toString()
Method toString.
-
Field Details
-
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
Method equals. -
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. -
setTargetFrame
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
Method toString.
-