DocumentHyperlinkBehaviour (Doxia

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.doxia.document
Class DocumentHyperlinkBehaviour

java.lang.Object
  org.apache.maven.doxia.document.DocumentHyperlinkBehaviour

All Implemented Interfaces:: Serializable

public class DocumentHyperlinkBehaviour
extends Object
implements Serializable
extends Object
implements Serializable

Specifies the default behavior for hyperlinks in the document.

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

Constructor Summary
`DocumentHyperlinkBehaviour()`

Method Summary
`boolean`	`equals(Object other)` Method equals.
`String`	`getTargetFrame()` Get the name of the default target frame.
`int`	`hashCode()` Method hashCode.
`void`	`setTargetFrame(String targetFrame)` Set the name of the default target frame.
`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(Object other)

Method equals.

Overrides:: equals in class Object

Parameters:: other -
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.