|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object project35.specifications.FunctionalSpecificationAspect
public abstract class FunctionalSpecificationAspect
this is a base class for other classes that generate sections of a functional specification. It contains many convenience methods that help hide html code from other classes.
Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.
Field Summary | |
---|---|
protected java.util.ArrayList |
columnValues
|
protected DocumentHeaderUtility |
documentHeaderUtility
|
protected java.lang.StringBuffer |
mainBodyBuffer
|
Constructor Summary | |
---|---|
FunctionalSpecificationAspect()
|
Method Summary | |
---|---|
protected void |
addColumnColourValue(java.awt.Color colour)
|
protected void |
addColumnHeader(java.lang.String columnHeader)
|
protected void |
addColumnValue(java.lang.String columnValue)
|
protected void |
addYesNoColumnValue(boolean isYes)
|
protected void |
beginColumnValue()
|
protected void |
beginParagraph()
|
protected void |
beginRow()
|
protected void |
beginTable()
|
protected void |
endColumnValue()
|
protected void |
endParagraph()
|
protected void |
endRow()
|
protected void |
endTable()
|
abstract void |
generateHTML()
generates the HTML for the functional specification aspect. |
protected java.lang.String |
getBulletedList(java.lang.String[] items)
|
java.lang.String |
getDescription()
provides the HTML text that was created through the generateHTML() method. |
protected java.lang.String |
getHyperLinkText(java.lang.String link,
java.lang.String body)
|
java.lang.String |
getJumpLinkTable()
provides a part of the jump link table that links to headings that are part of this section of the functional specifications |
protected void |
printBackToTop()
|
protected void |
printBoldHeading(java.lang.String heading)
|
protected void |
printBulletedList(java.util.ArrayList items)
|
protected void |
printBulletedList(java.lang.String[] items)
|
protected void |
printEnumeratedList(java.util.ArrayList items)
|
protected void |
printField(java.lang.String fieldName)
|
protected void |
printField(java.lang.String fieldName,
java.lang.String fieldValue)
|
protected void |
printHeading(java.lang.String heading)
|
protected void |
printHorizontalLine()
|
protected void |
printHyperLink(java.lang.String link,
java.lang.String body)
|
protected void |
printHyperLink(java.net.URL link,
java.lang.String body)
|
protected void |
printParagraphSeparator()
|
protected void |
printParagraphText(java.lang.String paragraphText)
|
protected java.lang.String |
replaceSpacesWithUnderscores(java.lang.String label)
|
void |
setSectionNumber(int sectionNumber)
establishes the section number associated with this section of the functional specification. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected DocumentHeaderUtility documentHeaderUtility
protected java.lang.StringBuffer mainBodyBuffer
protected java.util.ArrayList columnValues
Constructor Detail |
---|
public FunctionalSpecificationAspect()
Method Detail |
---|
public java.lang.String getDescription()
getDescription
in interface ServiceAspectDescription
public java.lang.String getJumpLinkTable()
public abstract void generateHTML()
protected void printBackToTop()
protected void printField(java.lang.String fieldName)
protected void printField(java.lang.String fieldName, java.lang.String fieldValue)
protected void beginColumnValue()
protected void endColumnValue()
protected void printBoldHeading(java.lang.String heading)
protected void printHeading(java.lang.String heading)
protected void beginParagraph()
protected void printParagraphText(java.lang.String paragraphText)
protected void endParagraph()
protected java.lang.String replaceSpacesWithUnderscores(java.lang.String label)
protected void printHorizontalLine()
protected void printParagraphSeparator()
protected void printEnumeratedList(java.util.ArrayList items)
protected void printBulletedList(java.util.ArrayList items)
protected void printBulletedList(java.lang.String[] items)
protected java.lang.String getBulletedList(java.lang.String[] items)
protected void printHyperLink(java.net.URL link, java.lang.String body)
protected void printHyperLink(java.lang.String link, java.lang.String body)
protected java.lang.String getHyperLinkText(java.lang.String link, java.lang.String body)
protected void beginRow()
protected void endRow()
protected void beginTable()
protected void endTable()
protected void addColumnHeader(java.lang.String columnHeader)
protected void addYesNoColumnValue(boolean isYes)
protected void addColumnValue(java.lang.String columnValue)
protected void addColumnColourValue(java.awt.Color colour)
public void setSectionNumber(int sectionNumber)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |