eu.bandm.tools.format

Class Format.Comment

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Format.Compound

eu.bandm.tools.format.Format.MayBreak

eu.bandm.tools.format.Format.Comment

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Enclosing class:

Format

public static class Format.Comment
extends Format.MayBreak

Arranges all sub-formats with leading asterisks, like a javadoc comment. Arranges all sub-formats in a text block which is smaller than usual, and prepends the comment-lead in prefix after each linefeed printed. This format is special because the line prefices must be inserted "physically" into the lower level "block" or "beneath" layout. always at the start of a line. Therefore they are handled by the Format.FormatPrinter directly. This has only one field for this purpose, thus Comments can NOT BE NESTED. This is checked not before trying to print.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class eu.bandm.tools.format.Format

Format.Annotated<A>, Format.Append, Format.Beneath, Format.Beside, Format.Block, Format.BoundVariable, Format.Comment, Format.Compound, Format.Context, Format.Empty, Format.Forester, Format.FormatPrinter, Format.FreeVariable, Format.Line, Format.Literal, Format.Markup, Format.Matcher, Format.MayBreak, Format.NonFormatPrinter, Format.Prior, Format.Rewriter, Format.Space, Format.Subst, Format.Tabular, Format.Variable, Format.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
protected String	linePrefix
protected @Opt String	prefix
protected @Opt String	suffix

Fields inherited from class eu.bandm.tools.format.Format.Compound

subs

Fields inherited from class eu.bandm.tools.format.Format

comma, contentPrefixPrinted, DEFAULT_WIDTH, dot, empty, ground, indent, INDENT_NOT_SET, invalid, isAlwaysMultiline, LENGTH_PREFIX, literal, maxWidth, minWidth, pattern_illegal_literal, pattern_newline, pattern_ws, pattern_wsWithVars, space

Fields inherited from interface eu.bandm.tools.format.Formattable

format

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Comment(@Opt String prefix, String linePrefix, @Opt String suffix, List<Format> f)

Method Summary

Modifier and Type	Method and Description
protected int	calcmax() Calculate maximal width.
protected int	calcmin() Calculate minimal width.
protected boolean	calcmult() returns the "or" of all sub-formats.
protected void	doprint(Format.FormatPrinter v) Over-ridden by concrete sub-classes of Format, for performing the adquate print operations.

Methods inherited from class eu.bandm.tools.format.Format.Compound

calcground, debugPrefix, endMutation, eval, getSubs, isMutating, startMutation, sumMin_noTrailingBlanks, update, validate

Methods inherited from class eu.bandm.tools.format.Format

annotated, append, append, apply, apply, apply, apply, applyPartial, applyTo, applyTo, beneath, beneath, beside, beside, block, block, comment, comment, comment, comment, format, indent, indentIsSet, invalidate, isSpace, isValidContentForLiteral, line, line, list, list, list, list, list, literal, main, makeAppend, makeBeneath, makeBeside, makeBlock, makeLine, makeTabular, markup, markupLeft, markupRight, printFormat, printFormat, printNonFormat, prior, prior, quoteDTDstyle, quoteJavaStyle, showLn, showLn, showSwingTree, space, subst, subst, subst, tabular, tabular, text, textWithVars, toFormat, toObjString, toString, toString, variable, variable

Methods inherited from class java.lang.Object

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

Field Detail

prefix

@Opt
protected @Opt String prefix

suffix

@Opt
protected @Opt String suffix

linePrefix

protected String linePrefix

Constructor Detail

Comment

protected Comment(@Opt
                  @Opt String prefix,
                  String linePrefix,
                  @Opt
                  @Opt String suffix,
                  List<Format> f)

Method Detail

calcmin

protected int calcmin()

Description copied from class: Format

Calculate minimal width. Is abstract on this level, but over-ridden by sub-classes.

Overrides:

calcmin in class Format.MayBreak

calcmax

protected int calcmax()

Description copied from class: Format

Calculate maximal width. Is abstract on this level, but over-ridden by sub-classes.

Overrides:

calcmax in class Format.MayBreak

calcmult

protected boolean calcmult()

Description copied from class: Format.Compound

returns the "or" of all sub-formats.

Overrides:

calcmult in class Format.Compound

doprint

protected void doprint(Format.FormatPrinter v)

Description copied from class: Format

Over-ridden by concrete sub-classes of Format, for performing the adquate print operations.

Specified by:

doprint in class Format