Multivalent API

multivalent.std.adaptor
Class Texinfo

java.lang.Object
  extended by multivalent.VObject
      extended by multivalent.Behavior
          extended by multivalent.MediaAdaptor
              extended by multivalent.std.adaptor.Texinfo

public class Texinfo
extends MediaAdaptor

Media adaptor for GNU's Texinfo format. Modeled after TkMan's Texinfo reader high quality display and outline navigation, vs nodes of ASCII. Internally, build index into parts of Texinfo source, fault in source and format on demand.

To do translate to XML so can markup right for stylesheet control architect so that easy to write translator to HTML (no outlining) generalize outlining used for man page, apply to man page, man page volumes (if all vols), Texinfo, local directory (tree)

Version:
$Revision: 1.6 $ $Date: 2005/01/01 12:58:41 $

Field Summary
 
Fields inherited from class multivalent.MediaAdaptor
HINT_DEFAULTS, HINT_EXACT, HINT_FAST, HINT_METADATA_ONLY, HINT_NO_IMAGE, HINT_NO_INTERACTIVE, HINT_NO_LAYOUT, HINT_NO_SHAPE, HINT_NO_SHOW, HINT_NO_STYLE, HINT_NO_TEXT, HINT_NO_TRANSCLUSION, HINT_NONE, HINT_NORMALIZE
 
Fields inherited from class multivalent.Behavior
ATTR_BEHAVIOR, name_
 
Fields inherited from class multivalent.VObject
attr_
 
Constructor Summary
Texinfo()
           
 
Method Summary
 void index(java.net.URI uri)
           
 void index2(java.net.URI uri)
          Recurse on @include.
 Node markup(java.net.URI uri, int offset, int endoff)
          Markup.
 java.lang.Object parse(INode parent)
          Read in index, creating on demand.
 boolean semanticEventAfter(SemanticEvent se, java.lang.String msg)
          On Document.MSG_STOP, set stop flag, which subclass has to check for periodically.
 
Methods inherited from class multivalent.MediaAdaptor
buildBefore, close, destroy, getHints, getInputUni, getURI, getZoom, isAuthorized, isStopped, parseHelper, setHints, setInput, setInput, setPassword, setZoom, stop
 
Methods inherited from class multivalent.Behavior
buildAfter, checkRep, clipboardAfter, clipboardBefore, createUI, eventAfter, eventBefore, formatAfter, formatBefore, getBrowser, getDocument, getInstance, getInstance, getLayer, getLogger, getName, getPreference, getRoot, isEditable, paintAfter, paintBefore, putPreference, redo, restore, restoreChildren, save, semanticEventBefore, setName, toString, undo
 
Methods inherited from class multivalent.VObject
attrEntrySetIterator, attrKeysIterator, clearAttributes, getAttr, getAttr, getAttributes, getGlobal, getValue, hasAttributes, putAttr, removeAttr, setAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Texinfo

public Texinfo()
Method Detail

parse

public java.lang.Object parse(INode parent)
                       throws java.io.IOException
Read in index, creating on demand.

Specified by:
parse in class MediaAdaptor
Returns:
whatever Object is appropriate to the media adaptor. For HTML it is the root of the HTML tree (which has name "html"), for documents with no single root it can be parent, for an image constuctor it could be an Image. However, the primary job of a media adaptor is to add content to the document tree.
Throws:
java.io.IOException
See Also:
for a convenient way to attach spans

index

public void index(java.net.URI uri)
           throws java.io.IOException
Throws:
java.io.IOException

index2

public void index2(java.net.URI uri)
            throws java.io.IOException
Recurse on @include.

Throws:
java.io.IOException

markup

public Node markup(java.net.URI uri,
                   int offset,
                   int endoff)
            throws java.io.IOException
Markup.

Throws:
java.io.IOException

semanticEventAfter

public boolean semanticEventAfter(SemanticEvent se,
                                  java.lang.String msg)
Description copied from class: MediaAdaptor
On Document.MSG_STOP, set stop flag, which subclass has to check for periodically.

Overrides:
semanticEventAfter in class MediaAdaptor

Multivalent API