com.sun.tools.doclets.internal.toolkit.util.links
Class LinkInfo

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo

Direct Known Subclasses:

LinkInfoImpl

public abstract class LinkInfo
extends java.lang.Object

Encapsulates information about a link.

Since:

1.5

Field Summary

ClassDoc	classDoc The ClassDoc we want to link to.
int	displayLength The display length for the link.
boolean	excludeTypeBounds True if we should exclude the type bounds for the type parameter.
boolean	excludeTypeBoundsLinks True if we should print the type bounds, but not link them.
boolean	excludeTypeParameterLinks True if we should print the type parameters, but not link them.
ExecutableMemberDoc	executableMemberDoc The executable member doc we want to link to.
boolean	includeTypeAsSepLink True if we should include the type as seperate link.
boolean	includeTypeInClassLinkLabel True if we should include the type in the link label.
boolean	isStrong True if the link should be strong.
boolean	isTypeBound Set this to true to indicate that you are linking to a type parameter.
boolean	isVarArg True if this is a link to a VarArg.
java.lang.String	label The label for the link.
boolean	linkToSelf By default, the link can be to the page it's already on.
Type	type The Type we want to link to.

Constructor Summary

LinkInfo()

Method Summary

java.lang.String	getClassLinkLabel(Configuration configuration) Return the label for this class link.
abstract int	getContext() Return the id indicating where the link appears in the documentation.
abstract boolean	isLinkable() Return true if this link is linkable and false if we can't link to the desired place.
abstract void	setContext(int c) Set the context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

classDoc

public ClassDoc classDoc

The ClassDoc we want to link to. Null if we are not linking to a ClassDoc.

executableMemberDoc

public ExecutableMemberDoc executableMemberDoc

The executable member doc we want to link to. Null if we are not linking to an executable member.

type

public Type type

The Type we want to link to. Null if we are not linking to a type.

isVarArg

public boolean isVarArg

True if this is a link to a VarArg.

isTypeBound

public boolean isTypeBound

Set this to true to indicate that you are linking to a type parameter.

label

public java.lang.String label

The label for the link.

isStrong

public boolean isStrong

True if the link should be strong.

includeTypeInClassLinkLabel

public boolean includeTypeInClassLinkLabel

True if we should include the type in the link label. False otherwise.

includeTypeAsSepLink

public boolean includeTypeAsSepLink

True if we should include the type as seperate link. False otherwise.

excludeTypeBounds

public boolean excludeTypeBounds

True if we should exclude the type bounds for the type parameter.

excludeTypeParameterLinks

public boolean excludeTypeParameterLinks

True if we should print the type parameters, but not link them.

excludeTypeBoundsLinks

public boolean excludeTypeBoundsLinks

True if we should print the type bounds, but not link them.

linkToSelf

public boolean linkToSelf

By default, the link can be to the page it's already on. However, there are cases where we don't want this (e.g. heading of class page).

displayLength

public int displayLength

The display length for the link.

Constructor Detail

LinkInfo

public LinkInfo()

Method Detail

getContext

public abstract int getContext()

Return the id indicating where the link appears in the documentation. This is used for special processing of different types of links.

Returns:

the id indicating where the link appears in the documentation.

setContext

public abstract void setContext(int c)

Set the context.

Parameters:

c - the context id to set.

isLinkable

public abstract boolean isLinkable()

Return true if this link is linkable and false if we can't link to the desired place.

Returns:

true if this link is linkable and false if we can't link to the desired place.

getClassLinkLabel

public java.lang.String getClassLinkLabel(Configuration configuration)

Return the label for this class link.

Parameters:

configuration - the current configuration of the doclet.

Returns:

the label for this class link.