Java Doc for LinkInfo.java in  » 6.0-JDK-Modules-com.sun » tools » com » sun » tools » doclets » internal » toolkit » util » links » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules com.sun » tools » com.sun.tools.doclets.internal.toolkit.util.links 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

All known Subclasses:   com.sun.tools.doclets.formats.html.LinkInfoImpl,
LinkInfo
abstract public class LinkInfo (Code)
Encapsulates information about a link.
author:
   Jamie Ho
since:
   1.5


Field Summary
public  ClassDocclassDoc
     The ClassDoc we want to link to.
public  intdisplayLength
     The display length for the link.
public  booleanexcludeTypeBounds
     True if we should exclude the type bounds for the type parameter.
public  booleanexcludeTypeBoundsLinks
     True if we should print the type bounds, but not link them.
public  booleanexcludeTypeParameterLinks
     True if we should print the type parameters, but not link them.
public  ExecutableMemberDocexecutableMemberDoc
     The executable member doc we want to link to.
public  booleanincludeTypeAsSepLink
     True if we should include the type as seperate link.
public  booleanincludeTypeInClassLinkLabel
     True if we should include the type in the link label.
public  booleanisBold
     True if the link should be bolded.
public  booleanisTypeBound
     Set this to true to indicate that you are linking to a type parameter.
public  booleanisVarArg
     True if this is a link to a VarArg.
public  Stringlabel
     The label for the link.
public  booleanlinkToSelf
     By default, the link can be to the page it's already on.
public  Typetype
     The Type we want to link to.


Method Summary
public  StringgetClassLinkLabel(Configuration configuration)
     Return the label for this class link.
Parameters:
  configuration - the current configuration of the doclet.
abstract public  intgetContext()
     Return the id indicating where the link appears in the documentation.
abstract public  booleanisLinkable()
     Return true if this link is linkable and false if we can't link to the desired place.
abstract public  voidsetContext(int c)
     Set the context.

Field Detail
classDoc
public ClassDoc classDoc(Code)
The ClassDoc we want to link to. Null if we are not linking to a ClassDoc.



displayLength
public int displayLength(Code)
The display length for the link.



excludeTypeBounds
public boolean excludeTypeBounds(Code)
True if we should exclude the type bounds for the type parameter.



excludeTypeBoundsLinks
public boolean excludeTypeBoundsLinks(Code)
True if we should print the type bounds, but not link them.



excludeTypeParameterLinks
public boolean excludeTypeParameterLinks(Code)
True if we should print the type parameters, but not link them.



executableMemberDoc
public ExecutableMemberDoc executableMemberDoc(Code)
The executable member doc we want to link to. Null if we are not linking to an executable member.



includeTypeAsSepLink
public boolean includeTypeAsSepLink(Code)
True if we should include the type as seperate link. False otherwise.



includeTypeInClassLinkLabel
public boolean includeTypeInClassLinkLabel(Code)
True if we should include the type in the link label. False otherwise.



isBold
public boolean isBold(Code)
True if the link should be bolded.



isTypeBound
public boolean isTypeBound(Code)
Set this to true to indicate that you are linking to a type parameter.



isVarArg
public boolean isVarArg(Code)
True if this is a link to a VarArg.



label
public String label(Code)
The label for the link.



linkToSelf
public boolean linkToSelf(Code)
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).



type
public Type type(Code)
The Type we want to link to. Null if we are not linking to a type.





Method Detail
getClassLinkLabel
public String getClassLinkLabel(Configuration configuration)(Code)
Return the label for this class link.
Parameters:
  configuration - the current configuration of the doclet. the label for this class link.



getContext
abstract public int getContext()(Code)
Return the id indicating where the link appears in the documentation. This is used for special processing of different types of links. the id indicating where the link appears in the documentation.



isLinkable
abstract 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
abstract public void setContext(int c)(Code)
Set the context.
Parameters:
  c - the context id to set.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

w_w_w_.j___a_v_a__2___s.co__m__ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.