Class LinkInfo
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo
- Direct Known Subclasses:
LinkInfoImpl
Deprecated.
Encapsulates information about a link.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.5
-
Field Summary
FieldsModifier and TypeFieldDescriptionDeprecated.The ClassDoc we want to link to.boolean
Deprecated.True if we should exclude the type bounds for the type parameter.boolean
Deprecated.True if we should print the type bounds, but not link them.boolean
Deprecated.True if we should print the type parameters, but not link them.Deprecated.The executable member doc we want to link to.boolean
Deprecated.True if we should include the type as separate link.boolean
Deprecated.True if we should include the type in the link label.boolean
Deprecated.Whether the document element is in a Java 5 declaration location or not.boolean
Deprecated.True if the link should be strong.boolean
Deprecated.Set this to true to indicate that you are linking to a type parameter.boolean
Deprecated.True if this is a link to a VarArg.Deprecated.The label for the link.boolean
Deprecated.By default, the link can be to the page it's already on.Deprecated.The Type we want to link to. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetClassLinkLabel
(Configuration configuration) Deprecated.Return the label for this class link.abstract boolean
Deprecated.Return true if this link is linkable and false if we can't link to the desired place.protected abstract Content
Deprecated.Return an empty instance of a content object.
-
Field Details
-
classDoc
Deprecated.The ClassDoc we want to link to. Null if we are not linking to a ClassDoc. -
executableMemberDoc
Deprecated.The executable member doc we want to link to. Null if we are not linking to an executable member. -
type
Deprecated.The Type we want to link to. Null if we are not linking to a type. -
isVarArg
public boolean isVarArgDeprecated.True if this is a link to a VarArg. -
isTypeBound
public boolean isTypeBoundDeprecated.Set this to true to indicate that you are linking to a type parameter. -
isJava5DeclarationLocation
public boolean isJava5DeclarationLocationDeprecated.Whether the document element is in a Java 5 declaration location or not. -
label
Deprecated.The label for the link. -
isStrong
public boolean isStrongDeprecated.True if the link should be strong. -
includeTypeInClassLinkLabel
public boolean includeTypeInClassLinkLabelDeprecated.True if we should include the type in the link label. False otherwise. -
includeTypeAsSepLink
public boolean includeTypeAsSepLinkDeprecated.True if we should include the type as separate link. False otherwise. -
excludeTypeBounds
public boolean excludeTypeBoundsDeprecated.True if we should exclude the type bounds for the type parameter. -
excludeTypeParameterLinks
public boolean excludeTypeParameterLinksDeprecated.True if we should print the type parameters, but not link them. -
excludeTypeBoundsLinks
public boolean excludeTypeBoundsLinksDeprecated.True if we should print the type bounds, but not link them. -
linkToSelf
public boolean linkToSelfDeprecated.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).
-
-
Constructor Details
-
LinkInfo
public LinkInfo()Deprecated.
-
-
Method Details
-
newContent
Deprecated.Return an empty instance of a content object.- Returns:
- an empty instance of a content object.
-
isLinkable
public abstract boolean isLinkable()Deprecated.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
Deprecated.Return the label for this class link.- Parameters:
configuration
- the current configuration of the doclet.- Returns:
- the label for this class link.
-