Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class LinkInfoImpl

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo

gw.gosudoc.com.sun.tools.doclets.formats.html.LinkInfoImpl

@Deprecated
public class LinkInfoImpl
extends LinkInfo

Deprecated.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LinkInfoImpl.Kind	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
ConfigurationImpl	configuration	Deprecated.
LinkInfoImpl.Kind	context	Deprecated. The location of the link.
String	styleName	Deprecated. String style of text defined in style sheet.
String	target	Deprecated. The value of the target.
String	where	Deprecated. The value of the marker #.

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo

classDoc, excludeTypeBounds, excludeTypeBoundsLinks, excludeTypeParameterLinks, executableMemberDoc, includeTypeAsSepLink, includeTypeInClassLinkLabel, isJava5DeclarationLocation, isStrong, isTypeBound, isVarArg, label, linkToSelf, type

Constructor Summary

Constructors

Constructor	Description
LinkInfoImpl(ConfigurationImpl configuration, LinkInfoImpl.Kind context, ClassDoc classDoc)	Deprecated. Construct a LinkInfo object.
LinkInfoImpl(ConfigurationImpl configuration, LinkInfoImpl.Kind context, ExecutableMemberDoc executableMemberDoc)	Deprecated. Construct a LinkInfo object.
LinkInfoImpl(ConfigurationImpl configuration, LinkInfoImpl.Kind context, Type type)	Deprecated. Construct a LinkInfo object.

Method Summary

Modifier and Type	Method	Description
LinkInfoImpl.Kind	getContext()	Deprecated.
boolean	isLinkable()	Deprecated. Return true if this link is linkable and false if we can't link to the desired place.
LinkInfoImpl	label(Content label)	Deprecated. Set the label for the link.
LinkInfoImpl	label(String label)	Deprecated. Set the label for the link.
protected Content	newContent()	Deprecated. Return an empty instance of a content object.
void	setContext(LinkInfoImpl.Kind c)	Deprecated. This method sets the link attributes to the appropriate values based on the context.
LinkInfoImpl	strong(boolean strong)	Deprecated. Set whether or not the link should be strong.
LinkInfoImpl	styleName(String styleName)	Deprecated. Set the style to be used for the link.
LinkInfoImpl	target(String target)	Deprecated. Set the target to be used for the link.
LinkInfoImpl	varargs(boolean varargs)	Deprecated. Set whether or not this is a link to a varargs parameter.
LinkInfoImpl	where(String where)	Deprecated. Set the fragment specifier for the link.

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo

getClassLinkLabel

Methods inherited from class java.lang.Object

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

Field Detail

configuration

public final ConfigurationImpl configuration

Deprecated.

context

public LinkInfoImpl.Kind context

Deprecated.

The location of the link.

where

public String where

Deprecated.

The value of the marker #.

styleName

public String styleName

Deprecated.

String style of text defined in style sheet.

target

public String target

Deprecated.

The value of the target.

Constructor Detail

LinkInfoImpl

public LinkInfoImpl(ConfigurationImpl configuration,
                    LinkInfoImpl.Kind context,
                    ExecutableMemberDoc executableMemberDoc)

Deprecated.

Construct a LinkInfo object.

Parameters:

configuration - the configuration data for the doclet

context - the context of the link.

context - the context of the link.

executableMemberDoc - the member to link to.

LinkInfoImpl

public LinkInfoImpl(ConfigurationImpl configuration,
                    LinkInfoImpl.Kind context,
                    ClassDoc classDoc)

Deprecated.

Construct a LinkInfo object.

Parameters:

configuration - the configuration data for the doclet

context - the context of the link.

classDoc - the class to link to.

LinkInfoImpl

public LinkInfoImpl(ConfigurationImpl configuration,
                    LinkInfoImpl.Kind context,
                    Type type)

Deprecated.

Construct a LinkInfo object.

Parameters:

configuration - the configuration data for the doclet

context - the context of the link.

type - the class to link to.

Method Detail

newContent

protected Content newContent()

Deprecated.

Return an empty instance of a content object.

Specified by:

newContent in class LinkInfo

Returns:

an empty instance of a content object.

label

public LinkInfoImpl label(String label)

Deprecated.

Set the label for the link.

Parameters:

label - plain-text label for the link

label

public LinkInfoImpl label(Content label)

Deprecated.

Set the label for the link.

strong

public LinkInfoImpl strong(boolean strong)

Deprecated.

Set whether or not the link should be strong.

styleName

public LinkInfoImpl styleName(String styleName)

Deprecated.

Set the style to be used for the link.

Parameters:

styleName - String style of text defined in style sheet.

target

public LinkInfoImpl target(String target)

Deprecated.

Set the target to be used for the link.

Parameters:

styleName - String style of text defined in style sheet.

varargs

public LinkInfoImpl varargs(boolean varargs)

Deprecated.

Set whether or not this is a link to a varargs parameter.

where

public LinkInfoImpl where(String where)

Deprecated.

Set the fragment specifier for the link.

getContext

public LinkInfoImpl.Kind getContext()

Deprecated.

setContext

public final void setContext(LinkInfoImpl.Kind c)

Deprecated.

This method sets the link attributes to the appropriate values based on the context.

Parameters:

c - the context id to set.

isLinkable

public boolean isLinkable()

Deprecated.

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

Specified by:

isLinkable in class LinkInfo

Returns:

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