Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.devtools.wiki.translators
Class DevtoolsLNFTranslator  view DevtoolsLNFTranslator download DevtoolsLNFTranslator.java

java.lang.Object
  extended byorg.devtools.wiki.translators.DevtoolsLNFTranslator
All Implemented Interfaces:
org.devtools.webtrans.Translator

public class DevtoolsLNFTranslator
extends java.lang.Object
implements org.devtools.webtrans.Translator

Inserts the wondrous devtools.org look and feel header and footer.

Expects the following parameters to be available from the TranslatorServices:


Field Summary
private  java.lang.String baseURL
           
private  java.lang.String delPage
           
private  java.lang.String editPage
           
private  java.lang.String findPage
           
private  java.lang.String frontPage
           
private  java.lang.String recentPage
           
private  java.lang.String type
           
 
Constructor Summary
DevtoolsLNFTranslator()
          Constructs a horizontal rule translator.
 
Method Summary
 java.lang.String getName()
          Returns the name of the translator.
 java.lang.String getUsage()
          Returns some HTML representing a description of what text this translator processes.
 void init(org.devtools.webtrans.TranslatorServices srv)
          A constructor-like initialization method.
 void translate(org.devtools.webtrans.StringChanges c, org.devtools.webtrans.WebContent content, org.devtools.webtrans.TranslatorLog log, java.util.Properties query)
          Replaces < symbols with the < HTML symbol.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

baseURL

private java.lang.String baseURL

type

private java.lang.String type

editPage

private java.lang.String editPage

delPage

private java.lang.String delPage

frontPage

private java.lang.String frontPage

findPage

private java.lang.String findPage

recentPage

private java.lang.String recentPage
Constructor Detail

DevtoolsLNFTranslator

public DevtoolsLNFTranslator()
Constructs a horizontal rule translator.

Method Detail

init

public void init(org.devtools.webtrans.TranslatorServices srv)
A constructor-like initialization method. The TranslatorManager will call this method exactly once, before any calls to translate(). The Translator may choose to do nothing during this method, or it may choose to save the reference to the provided TranslatorServices, which provide getters for commonly needed information such as the site's Persister, its base URL, the location of Special Pages such as the front page, search page, edit page, putter page, etc.

This method replaces a parametric constructor, so that Translators can be created using the getInstance() method on class Class, which requires a no-arg constructor.

Specified by:
init in interface org.devtools.webtrans.Translator

getName

public java.lang.String getName()
Returns the name of the translator. This should be something descriptive and human-readable that uniquely indicates what the translator does. This name will be included in error logging if this translator has a conflict with another one, throws an exception, etc.

Specified by:
getName in interface org.devtools.webtrans.Translator

getUsage

public java.lang.String getUsage()
Returns some HTML representing a description of what text this translator processes. This will be shown to the user so that they can determine how to write their documents. (If this translator has no usage or if you wish it to be invisible to the user, return null. This Translator will not be included in the usage list.)

Specified by:
getUsage in interface org.devtools.webtrans.Translator

translate

public void translate(org.devtools.webtrans.StringChanges c,
                      org.devtools.webtrans.WebContent content,
                      org.devtools.webtrans.TranslatorLog log,
                      java.util.Properties query)
Replaces < symbols with the < HTML symbol.

Specified by:
translate in interface org.devtools.webtrans.Translator