| java.lang.Object com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo com.sun.tools.doclets.formats.html.LinkInfoImpl
Constructor Summary | |
public | LinkInfoImpl(int context, ClassDoc classDoc, String label, String target) Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: classDoc - the class to link to. Parameters: label - the label for the link. Parameters: target - the value of the target attribute. | public | LinkInfoImpl(int context, ClassDoc classDoc, String where, String label, boolean isBold, String styleName) Construct a LinkInfo object. | public | LinkInfoImpl(int context, ClassDoc classDoc, String where, String label, boolean isBold) Construct a LinkInfo object. | public | LinkInfoImpl(ClassDoc classDoc, String label) Construct a LinkInfo object. | public | LinkInfoImpl(int context, ExecutableMemberDoc executableMemberDoc, boolean isBold) Construct a LinkInfo object. | public | LinkInfoImpl(int context, ClassDoc classDoc, boolean isBold) Construct a LinkInfo object. | public | LinkInfoImpl(int context, Type type) Construct a LinkInfo object. | public | LinkInfoImpl(int context, Type type, boolean isVarArg) Construct a LinkInfo object. | public | LinkInfoImpl(int context, Type type, String label, boolean isBold) Construct a LinkInfo object. | public | LinkInfoImpl(int context, ClassDoc classDoc, String label, boolean isBold) Construct a LinkInfo object. |
Method Summary | |
public int | getContext() | public boolean | isLinkable() Return true if this link is linkable and false if we can't link to the
desired place. | public void | setContext(int c)
This method sets the link attributes to the appropriate values
based on the context. |
ALL_CLASSES_FRAME | final public static int ALL_CLASSES_FRAME(Code) | | Indicate that the link appears in a class list.
|
CONTEXT_ANNOTATION | final public static int CONTEXT_ANNOTATION(Code) | | Annotation link.
|
CONTEXT_CLASS | final public static int CONTEXT_CLASS(Code) | | Indicate that the link appears in a class documentation.
|
CONTEXT_CLASS_HEADER | final public static int CONTEXT_CLASS_HEADER(Code) | | The header in the class documentation.
|
CONTEXT_CLASS_SIGNATURE | final public static int CONTEXT_CLASS_SIGNATURE(Code) | | The signature in the class documentation.
|
CONTEXT_CLASS_SIGNATURE_PARENT_NAME | final public static int CONTEXT_CLASS_SIGNATURE_PARENT_NAME(Code) | | The signature in the class documentation (implements/extends portion).
|
CONTEXT_CLASS_TREE_PARENT | final public static int CONTEXT_CLASS_TREE_PARENT(Code) | | The parent nodes int the class tree.
|
CONTEXT_CLASS_USE | final public static int CONTEXT_CLASS_USE(Code) | | Indicate that the link appears in class use documentation.
|
CONTEXT_CLASS_USE_HEADER | final public static int CONTEXT_CLASS_USE_HEADER(Code) | | Indicate that the link appears in class use documentation.
|
CONTEXT_CONSTANT_SUMMARY | final public static int CONTEXT_CONSTANT_SUMMARY(Code) | | Indicate that the link appears in constant value summary.
|
CONTEXT_EXECUTABLE_MEMBER_PARAM | final public static int CONTEXT_EXECUTABLE_MEMBER_PARAM(Code) | | The type of a method/constructor parameter.
|
CONTEXT_FIELD_DOC_COPY | final public static int CONTEXT_FIELD_DOC_COPY(Code) | | The header for field documentation copied from parent.
|
CONTEXT_IMPLEMENTED_CLASSES | final public static int CONTEXT_IMPLEMENTED_CLASSES(Code) | | Implemented class links.
|
CONTEXT_IMPLEMENTED_INTERFACES | final public static int CONTEXT_IMPLEMENTED_INTERFACES(Code) | | Implemented interface links.
|
CONTEXT_INDEX | final public static int CONTEXT_INDEX(Code) | | Indicate that the link appears in index documentation.
|
CONTEXT_MEMBER | final public static int CONTEXT_MEMBER(Code) | | Indicate that the link appears in member documentation.
|
CONTEXT_MEMBER_TYPE_PARAMS | final public static int CONTEXT_MEMBER_TYPE_PARAMS(Code) | | The type parameters of a method or constructor.
|
CONTEXT_METHOD_DOC_COPY | final public static int CONTEXT_METHOD_DOC_COPY(Code) | | The header for method documentation copied from parent.
|
CONTEXT_METHOD_OVERRIDES | final public static int CONTEXT_METHOD_OVERRIDES(Code) | | Method "overrides" link.
|
CONTEXT_METHOD_SPECIFIED_BY | final public static int CONTEXT_METHOD_SPECIFIED_BY(Code) | | Method "specified by" link.
|
CONTEXT_PACKAGE | final public static int CONTEXT_PACKAGE(Code) | | Indicate that the link appears in package documentation.
|
CONTEXT_RETURN_TYPE | final public static int CONTEXT_RETURN_TYPE(Code) | | The return type of a method.
|
CONTEXT_SEE_TAG | final public static int CONTEXT_SEE_TAG(Code) | | Indicate that the link appears in see tag documentation.
|
CONTEXT_SERIALIZED_FORM | final public static int CONTEXT_SERIALIZED_FORM(Code) | | Indicate that the link appears in serialized form documentation.
|
CONTEXT_SERIAL_MEMBER | final public static int CONTEXT_SERIAL_MEMBER(Code) | | Indicate that the link appears in serial member documentation.
|
CONTEXT_SUBCLASSES | final public static int CONTEXT_SUBCLASSES(Code) | | Subclasses links.
|
CONTEXT_SUBINTERFACES | final public static int CONTEXT_SUBINTERFACES(Code) | | Subinterface links.
|
CONTEXT_SUMMARY_RETURN_TYPE | final public static int CONTEXT_SUMMARY_RETURN_TYPE(Code) | | The return type of a method in a member summary.
|
CONTEXT_SUPER_INTERFACES | final public static int CONTEXT_SUPER_INTERFACES(Code) | | Super interface links.
|
CONTEXT_TREE | final public static int CONTEXT_TREE(Code) | | Indicate that the link appears in tree documentation.
|
CONTEXT_VALUE_TAG | final public static int CONTEXT_VALUE_TAG(Code) | | Indicate that the link appears in value tag documentation.
|
PACKAGE_FRAME | final public static int PACKAGE_FRAME(Code) | | Indicate that the link appears in a class list.
|
context | public int context(Code) | | The integer indicating the location of the link.
|
styleName | public String styleName(Code) | | String style of text defined in style sheet.
|
LinkInfoImpl | public LinkInfoImpl(int context, ClassDoc classDoc, String label, String target)(Code) | | Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: classDoc - the class to link to. Parameters: label - the label for the link. Parameters: target - the value of the target attribute. |
LinkInfoImpl | public LinkInfoImpl(int context, ClassDoc classDoc, String where, String label, boolean isBold, String styleName)(Code) | | Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: classDoc - the class to link to. Parameters: where - the value of the marker #. Parameters: label - the label for the link. Parameters: isBold - true if the link should be bold. Parameters: styleName - String style of text defined in style sheet. |
LinkInfoImpl | public LinkInfoImpl(int context, ClassDoc classDoc, String where, String label, boolean isBold)(Code) | | Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: classDoc - the class to link to. Parameters: where - the value of the marker #. Parameters: label - the label for the link. Parameters: isBold - true if the link should be bold. |
LinkInfoImpl | public LinkInfoImpl(ClassDoc classDoc, String label)(Code) | | Construct a LinkInfo object.
Parameters: classDoc - the class to link to. Parameters: label - the label for the link. |
LinkInfoImpl | public LinkInfoImpl(int context, ExecutableMemberDoc executableMemberDoc, boolean isBold)(Code) | | Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: executableMemberDoc - the member to link to. Parameters: isBold - true if the link should be bold. |
LinkInfoImpl | public LinkInfoImpl(int context, ClassDoc classDoc, boolean isBold)(Code) | | Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: classDoc - the class to link to. Parameters: isBold - true if the link should be bold. |
LinkInfoImpl | public LinkInfoImpl(int context, Type type)(Code) | | Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: type - the class to link to. |
LinkInfoImpl | public LinkInfoImpl(int context, Type type, boolean isVarArg)(Code) | | Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: type - the class to link to. Parameters: isVarArg - true if this is a link to a var arg. |
LinkInfoImpl | public LinkInfoImpl(int context, Type type, String label, boolean isBold)(Code) | | Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: type - the class to link to. Parameters: label - the label for the link. Parameters: isBold - true if the link should be bold. |
LinkInfoImpl | public LinkInfoImpl(int context, ClassDoc classDoc, String label, boolean isBold)(Code) | | Construct a LinkInfo object.
Parameters: context - the context of the link. Parameters: classDoc - the class to link to. Parameters: label - the label for the link. Parameters: isBold - true if the link should be bold. |
getContext | public int getContext()(Code) | | |
isLinkable | public boolean isLinkable()(Code) | | Return true if this link is linkable and false if we can't link to the
desired place.
true if this link is linkable and false if we can't link to thedesired place. |
setContext | public void setContext(int c)(Code) | |
This method sets the link attributes to the appropriate values
based on the context.
Parameters: c - the context id to set. |
|
|