Java Doc for ParserInput.java in  » Wiki-Engine » JAMWiki » org » jamwiki » parser » 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 » Wiki Engine » JAMWiki » org.jamwiki.parser   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.jamwiki.parser.ParserInput ParserInput public class ParserInput (Code) This class is a utility class used to hold configuration settings for the parser. Constructor Summary public   ParserInput()      public   ParserInput(ParserInput parserInput)      Copy constructor. Method Summary public  void decrementDepth()      This method decreases the current parser instance depth and should only be called when a parser instance exits. public  void decrementTemplateDepth()      This method decreases the current template inclusion depth and should only be called when a template finishes processing. public  boolean getAllowSectionEdit()      This method will return true if edit links are allowed next to each section heading. public  String getContext()      Get the servlet context associated with the current parser input instance. public  int getDepth()      Since it is possible to call a new parser instance from within another parser instance, depth provides a way to determine how many times the parser has nested, thus providing a way of avoiding infinite loops. public  Locale getLocale()      Get the locale associated with the current parser input instance. public  TableOfContents getTableOfContents()      Get the table of contents object associated with the current parser input instance. public  Hashtable getTempParams()      Get the Hashtable of arbitrary temporary parameters associated with the current parser input instance. public  int getTemplateDepth()      Get the depth level when template code is being parsed. public  String getTopicName()      Get the topic name for the topic being parsed by this parser input instance. public  String getUserIpAddress()      Get the user IP address associated with the current parser input instance. public  String getVirtualWiki()      Get the virtual wiki name associated with the current parser input instance. public  WikiUser getWikiUser()      Get the wiki user object associated with the current parser input instance. public  void incrementDepth()      This method increases the current parser instance depth and should only be called when a instantiating a new parser instance. public  void incrementTemplateDepth()      This method decreases the current template inclusion depth and should only be called when a template begins processing. public  void setAllowSectionEdit(boolean allowSectionEdit)      Set method used to indicate whether or not to allow edit links next to each section heading. public  void setContext(String context)      Set the servlet context associated with the current parser input instance. public  void setDepth(int depth)      Since it is possible to call a new parser instance from within another parser instance, depth provides a way to determine how many times the parser has nested, thus providing a way of avoiding infinite loops. public  void setLocale(Locale locale)      Set the locale associated with the current parser input instance. public  void setTableOfContents(TableOfContents tableOfContents)      Set the table of contents object associated with the current parser input instance. public  void setTemplateDepth(int templateDepth)      Set the depth level when template code is being parsed. public  void setTopicName(String topicName)      Set the topic name for the topic being parsed by this parser input instance. public  void setUserIpAddress(String userIpAddress)      Set the user IP address associated with the current parser input instance. public  void setVirtualWiki(String virtualWiki)      Set the virtual wiki name associated with the current parser input instance. public  void setWikiUser(WikiUser user)      Set the wiki user object associated with the current parser input instance. Constructor Detail ParserInput public ParserInput()(Code) ParserInput public ParserInput(ParserInput parserInput)(Code) Copy constructor. Method Detail decrementDepth public void decrementDepth()(Code) This method decreases the current parser instance depth and should only be called when a parser instance exits. Depth is useful as a way of avoiding infinite loops in the parser. decrementTemplateDepth public void decrementTemplateDepth()(Code) This method decreases the current template inclusion depth and should only be called when a template finishes processing. getAllowSectionEdit public boolean getAllowSectionEdit()(Code) This method will return true if edit links are allowed next to each section heading. During preview and in some other instances that feature needs to be disabled. Returns true if edit links are allowed next toeach section heading. getContext public String getContext()(Code) Get the servlet context associated with the current parser input instance. Servlet context is used when building links. The servlet context associated with the current parserinput instance. getDepth public int getDepth()(Code) Since it is possible to call a new parser instance from within another parser instance, depth provides a way to determine how many times the parser has nested, thus providing a way of avoiding infinite loops. The current nesting level of the parser instance. getLocale public Locale getLocale()(Code) Get the locale associated with the current parser input instance. Locale is used primarily when building links or displaying messages. The locale associated with the current parser input instance. getTableOfContents public TableOfContents getTableOfContents()(Code) Get the table of contents object associated with the current parser input instance. The table of contents is used for building an internal set of links to headings in the current document. The table of contents object associated with the current parserinput instance. getTempParams public Hashtable getTempParams()(Code) Get the Hashtable of arbitrary temporary parameters associated with the current parser input instance. This hashtable provides a method for the parser to keep track of arbitrary data during the parsing process. The Hashtable of arbitrary temporary parameters associated withthe current parser input instance. getTemplateDepth public int getTemplateDepth()(Code) Get the depth level when template code is being parsed. The current number of template inclusions. getTopicName public String getTopicName()(Code) Get the topic name for the topic being parsed by this parser input instance. The topic name for the topic being parsed by this parser inputinstance. getUserIpAddress public String getUserIpAddress()(Code) Get the user IP address associated with the current parser input instance. The user IP address is used primarily when parsing signatures. The user IP address associated with the current parser inputinstance. getVirtualWiki public String getVirtualWiki()(Code) Get the virtual wiki name associated with the current parser input instance. The virtual wiki name is used primarily when parsing links. The virtual wiki name associated with the current parser inputinstance. getWikiUser public WikiUser getWikiUser()(Code) Get the wiki user object associated with the current parser input instance. The wiki user object is used primarily when parsing signatures. The wiki user object associated with the current parser inputinstance. incrementDepth public void incrementDepth()(Code) This method increases the current parser instance depth and should only be called when a instantiating a new parser instance. Depth is useful as a way of avoiding infinite loops in the parser. incrementTemplateDepth public void incrementTemplateDepth()(Code) This method decreases the current template inclusion depth and should only be called when a template begins processing. setAllowSectionEdit public void setAllowSectionEdit(boolean allowSectionEdit)(Code) Set method used to indicate whether or not to allow edit links next to each section heading. During preview and in some other instances that feature needs to be disabled. Parameters:   allowSectionEdit - Set to true if edits links areallowed next to each section heading, false otherwise. setContext public void setContext(String context)(Code) Set the servlet context associated with the current parser input instance. Servlet context is used when building links. Parameters:   context - The servlet context associated with the current parserinput instance. setDepth public void setDepth(int depth)(Code) Since it is possible to call a new parser instance from within another parser instance, depth provides a way to determine how many times the parser has nested, thus providing a way of avoiding infinite loops. Parameters:   depth - The current nesting level of the parser instance. setLocale public void setLocale(Locale locale)(Code) Set the locale associated with the current parser input instance. Locale is used primarily when building links or displaying messages. Parameters:   locale - The locale associated with the current parser inputinstance. setTableOfContents public void setTableOfContents(TableOfContents tableOfContents)(Code) Set the table of contents object associated with the current parser input instance. The table of contents is used for building an internal set of links to headings in the current document. Parameters:   tableOfContents - The table of contents object associated with thecurrent parser input instance. setTemplateDepth public void setTemplateDepth(int templateDepth)(Code) Set the depth level when template code is being parsed. Parameters:   templateDepth - The current number of template inclusions. setTopicName public void setTopicName(String topicName)(Code) Set the topic name for the topic being parsed by this parser input instance. Parameters:   topicName - The topic name for the topic being parsed by thisparser input instance. setUserIpAddress public void setUserIpAddress(String userIpAddress)(Code) Set the user IP address associated with the current parser input instance. The user IP address is used primarily when parsing signatures. Parameters:   userIpAddress - The user IP address associated with the currentparser input instance. setVirtualWiki public void setVirtualWiki(String virtualWiki)(Code) Set the virtual wiki name associated with the current parser input instance. The virtual wiki name is used primarily when parsing links. Parameters:   virtualWiki - The virtual wiki name associated with the currentparser input instance. setWikiUser public void setWikiUser(WikiUser user)(Code) Set the wiki user object associated with the current parser input instance. The wiki user object is used primarily when parsing signatures. Parameters:   user - The wiki user object associated with the currentparser input instance. 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)