de.goerntkai.scot.app.document
Class ListBlock

java.lang.Object
  extended byde.goerntkai.scot.app.document.SCoTBlock
      extended byde.goerntkai.scot.app.document.ListBlock
All Implemented Interfaces:
ISCoTComponent

public class ListBlock
extends SCoTBlock

Represents a block of lines forming an ordered list, an unordered list or a definition list. An ordered list or an unordered list may be substructured with another ordered or unordered list.

Version:
$Id: ListBlock.java,v 1.5 2005/05/19 20:19:36 GoerntKai Exp $
Author:
Kai Görnt

Constructor Summary
ListBlock(java.lang.String line)
          Deprecated.  
ListBlock(java.lang.String line, Configuration aConfiguration)
          This constructor interpretes the given line.
 
Method Summary
 void add(java.lang.String line)
          Adds a new element to the components.
 boolean isMeaningEqual(java.lang.String line)
          Returns true when the meaning of the line is the same as the meaning of the block and false if not.
 org.w3c.dom.Node toHTML(org.w3c.dom.Document doc)
          Returns the HTML representation of the element.
 
Methods inherited from class de.goerntkai.scot.app.document.SCoTBlock
add, getAttributes, getComponents, getConfiguration, getLastComponent, replaceLastComponentBy, setAttributes
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ListBlock

public ListBlock(java.lang.String line)
          throws SCoTException
Deprecated.  

Only for testing!

Parameters:
line -
Throws:
SCoTException

ListBlock

public ListBlock(java.lang.String line,
                 Configuration aConfiguration)
          throws SCoTException

This constructor interpretes the given line. The line given must have the format <line> ::= <meaning>+<content>.

Parameters:
line - the line as found in a SCoT document
aConfiguration - the configuration of this application
Throws:
SCoTException
Method Detail

add

public void add(java.lang.String line)
         throws SCoTException

Adds a new element to the components. This method creates a new ListBlock if the line belongs to a sub list (may only be in ordered or unordered lists).

Specified by:
add in class SCoTBlock
Parameters:
line - the new component line
Throws:
SCoTException
See Also:
SCoTBlock.add(java.lang.String)

isMeaningEqual

public boolean isMeaningEqual(java.lang.String line)

Returns true when the meaning of the line is the same as the meaning of the block and false if not.

The meaning of the line is equal to the meaning of the block if the first character of the line is equal to the meaning of the block. In case that the line has meaning '.' the meaning of the line is switched to '?'.

Specified by:
isMeaningEqual in class SCoTBlock
Parameters:
line - the line to be checked
Returns:
wether the line has the same meaning as the block
See Also:
SCoTBlock.isMeaningEqual(java.lang.String)

toHTML

public org.w3c.dom.Node toHTML(org.w3c.dom.Document doc)

Returns the HTML representation of the element. Uses the parent document for creating the node.

Specified by:
toHTML in interface ISCoTComponent
Specified by:
toHTML in class SCoTBlock
Parameters:
doc - the parent document
Returns:
the HTML representation
See Also:
ISCoTComponent.toHTML(org.w3c.dom.Document)


© 2004 by Kai Görnt