org.yarnandtail.andhow.sample

Class TextBlock

java.lang.Object

org.yarnandtail.andhow.sample.TextBlock

public class TextBlock
extends Object

A block of Text made up of multiple TextLines.

Constructor Summary

Constructors

Constructor and Description
TextBlock(boolean wrap, boolean comment) New instance

Method Summary

Modifier and Type	Method and Description
TextBlock	addBlank() Add a blank line, added as a TextLine.BlankLine.
TextBlock	addHR() Add a Horizontal Rule line, added as a TextLine.HRLine.
TextBlock	addLine(String strLine) Add a String, which will be added as TextLine with the wrap setting inherited from this block.
TextLine	getLine(int i) Return a single TextLine
ArrayList<TextLine>	getLines() Return all the TextLines in this block.
boolean	isBlankLineAfter() Should a blank line be printed after this block?
boolean	isBlankLineBefore() Should a blank line be printed before this block?
boolean	isComment() Should the text in this block be printed as a comment?
boolean	isWrap() Should lines in this block be wrapped to the max column width?
void	setBlankLineAfter(boolean blankLineAfter) Specify if a blank line be printed after this block.
void	setBlankLineBefore(boolean blankLineBefore) Specify if a blank line be printed before this block.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextBlock

public TextBlock(boolean wrap,
                 boolean comment)

New instance

Parameters:

wrap - Should contained text be wrapped to the max column width?

comment - Should the text in this block be printed as a comment?

Method Detail

addLine

public TextBlock addLine(String strLine)

Add a String, which will be added as TextLine with the wrap setting inherited from this block.

Parameters:

strLine -

Returns:

addHR

public TextBlock addHR()

Add a Horizontal Rule line, added as a TextLine.HRLine.

Returns:

addBlank

public TextBlock addBlank()

Add a blank line, added as a TextLine.BlankLine.

Returns:

isWrap

public boolean isWrap()

Should lines in this block be wrapped to the max column width?

Returns:

isComment

public boolean isComment()

Should the text in this block be printed as a comment?

Returns:

getLines

public ArrayList<TextLine> getLines()

Return all the TextLines in this block.

Returns:

getLine

public TextLine getLine(int i)

Return a single TextLine

Parameters:

i - index is zero based.

Returns:

isBlankLineBefore

public boolean isBlankLineBefore()

Should a blank line be printed before this block?

Returns:

isBlankLineAfter

public boolean isBlankLineAfter()

Should a blank line be printed after this block?

Returns:

setBlankLineBefore

public void setBlankLineBefore(boolean blankLineBefore)

Specify if a blank line be printed before this block.

Parameters:

blankLineBefore -

setBlankLineAfter

public void setBlankLineAfter(boolean blankLineAfter)

Specify if a blank line be printed after this block.

Parameters:

blankLineAfter -