org.apache.maven.doxia.document
Class DocumentHyperlinkBehaviour

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

public class DocumentHyperlinkBehaviour
extends java.lang.Object
implements java.io.Serializable

Specifies the default behavior for hyperlinks in the document.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
DocumentHyperlinkBehaviour()
           
 
Method Summary
 boolean equals(java.lang.Object other)
          Method equals
 java.lang.String getModelEncoding()
           
 java.lang.String getTargetFrame()
          Get The name of the default target frame.
 int hashCode()
          Method hashCode
 void setModelEncoding(java.lang.String modelEncoding)
           
 void setTargetFrame(java.lang.String targetFrame)
          Set The name of the default target frame.
 java.lang.String toString()
          Method toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DocumentHyperlinkBehaviour

public DocumentHyperlinkBehaviour()
Method Detail

equals

public boolean equals(java.lang.Object other)
Method equals

Overrides:
equals in class java.lang.Object
Parameters:
other -

getTargetFrame

public java.lang.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.


hashCode

public int hashCode()
Method hashCode

Overrides:
hashCode in class java.lang.Object

setTargetFrame

public void setTargetFrame(java.lang.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 -

toString

public java.lang.String toString()
Method toString

Overrides:
toString in class java.lang.Object

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()


Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved.