Java Doc for HelpUtils.java in  » IDE-Netbeans » visualweb.api.designer » com » sun » rave » web » ui » util » 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 » IDE Netbeans » visualweb.api.designer » com.sun.rave.web.ui.util   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    com.sun.rave.web.ui.util.HelpUtils HelpUtils public class HelpUtils implements SearchListener(Code) This is a set of utilities used for accessing JavaHelp content. author:    Sun Microsystems, Inc. Field Summary final public static  String BASE_ID      Node ID of the root treenode. final protected static  String DEFAULT_HELPSET_NAME      final protected static  String HELP_DIR      final protected static  String HTML_DIR      final public static  String INDEX_VIEW_NAME      final protected static  String REQUEST_SCHEME      Tips on searching path. final public static  String SEARCH_VIEW_NAME      final protected static  String TIPS_ON_SEARCHING_FILE      final public static  String TOC_VIEW_NAME      final public static  String URL_SEPARATOR       int httpPort      Constructor Summary public   HelpUtils(HttpServletRequest request, String appName, int httpPort)      Constructor. public   HelpUtils(HttpServletRequest request, String appName, String pathPrefix)      Constructor. Method Summary public synchronized  Enumeration doSearch(String query)      Do a search on the query passed in. public  String getContentURL(TreeItem item)      Return the content URL in String form for a given TreeItem, or an empty String if no content exists. public  String getDefaultHelpSetPath()      Return the path to the default helpset file. public  ServletHelpBroker getHelpBroker()      Return a handle to the ServletHelpBroker. public  String getID(TreeNode node)      Return the ID of the given node. public  ArrayList getIndexTreeList()      Return the Index tree enumeration as an ArrayList object. public  String getLocalizedHelpPath()      public  ArrayList getTOCTreeList()      Return the TOC tree enumeration as an ArrayList object. public  String getTipsOnSearchingPath(ServletContext context)      Get the path to the localized tips_on_searching help file. public  String indexTreeToString(DefaultMutableTreeNode node)      Return a string containing the contents of the given Index tree node. public synchronized  void itemsFound(SearchEvent e)      Tells the listener that matching SearchItems have been found. public  void printDebug()      For debug - print the attributes of each node in the toc and index trees. public synchronized  void searchFinished(SearchEvent e)      Tells the listener that the search has finished. public synchronized  void searchStarted(SearchEvent e)      Tells the listener that the search has started. public  void setCurrentHelpPage(URL url)      Set the path to the "current" page. public  String tocTreeToString(DefaultMutableTreeNode node)      Return a string containing the contents of the given TOC tree node. public  void validateHelpSet(HttpServletRequest request, String hsName, boolean merge)      This method validates the helpset. public  void validateID(String helpID)      Validate the given help id. Field Detail BASE_ID final public static String BASE_ID(Code) Node ID of the root treenode. DEFAULT_HELPSET_NAME final protected static String DEFAULT_HELPSET_NAME(Code) HELP_DIR final protected static String HELP_DIR(Code) HTML_DIR final protected static String HTML_DIR(Code) INDEX_VIEW_NAME final public static String INDEX_VIEW_NAME(Code) REQUEST_SCHEME final protected static String REQUEST_SCHEME(Code) Tips on searching path. SEARCH_VIEW_NAME final public static String SEARCH_VIEW_NAME(Code) TIPS_ON_SEARCHING_FILE final protected static String TIPS_ON_SEARCHING_FILE(Code) TOC_VIEW_NAME final public static String TOC_VIEW_NAME(Code) URL_SEPARATOR final public static String URL_SEPARATOR(Code) httpPort int httpPort(Code) Constructor Detail HelpUtils public HelpUtils(HttpServletRequest request, String appName, int httpPort)(Code) Constructor. HelpUtils public HelpUtils(HttpServletRequest request, String appName, String pathPrefix)(Code) Constructor. Method Detail doSearch public synchronized Enumeration doSearch(String query)(Code) Do a search on the query passed in. getContentURL public String getContentURL(TreeItem item)(Code) Return the content URL in String form for a given TreeItem, or an empty String if no content exists. getDefaultHelpSetPath public String getDefaultHelpSetPath()(Code) Return the path to the default helpset file. The path will be formatted as follows: //html//help/app.hs getHelpBroker public ServletHelpBroker getHelpBroker()(Code) Return a handle to the ServletHelpBroker. getID public String getID(TreeNode node)(Code) Return the ID of the given node. getIndexTreeList public ArrayList getIndexTreeList()(Code) Return the Index tree enumeration as an ArrayList object. getLocalizedHelpPath public String getLocalizedHelpPath()(Code) getTOCTreeList public ArrayList getTOCTreeList()(Code) Return the TOC tree enumeration as an ArrayList object. getTipsOnSearchingPath public String getTipsOnSearchingPath(ServletContext context)(Code) Get the path to the localized tips_on_searching help file. indexTreeToString public String indexTreeToString(DefaultMutableTreeNode node)(Code) Return a string containing the contents of the given Index tree node. itemsFound public synchronized void itemsFound(SearchEvent e)(Code) Tells the listener that matching SearchItems have been found. printDebug public void printDebug()(Code) For debug - print the attributes of each node in the toc and index trees. searchFinished public synchronized void searchFinished(SearchEvent e)(Code) Tells the listener that the search has finished. searchStarted public synchronized void searchStarted(SearchEvent e)(Code) Tells the listener that the search has started. setCurrentHelpPage public void setCurrentHelpPage(URL url)(Code) Set the path to the "current" page. tocTreeToString public String tocTreeToString(DefaultMutableTreeNode node)(Code) Return a string containing the contents of the given TOC tree node. validateHelpSet public void validateHelpSet(HttpServletRequest request, String hsName, boolean merge)(Code) This method validates the helpset. Parameters:   request - The request for this page. Parameters:   hsName - The helpset name. Parameters:   merge - Indicates whether the helpset hsName should be merged. validateID public void validateID(String helpID)(Code) Validate the given help id. If none is specified, set the current id to the home id. Parameters:   helpID - the current ID. 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)