com.instantbank.component.lettertemplate.util
Interface LetterViewable

All Known Implementing Classes:
Template, LetterComponent

public interface LetterViewable

Groups Template and LetterComponent objects as "viewable" objects; i.e: those that can be transformed to a printable version.

Author:
InstantBank (Rodrigo Lopez)

Method Summary
 java.util.ArrayList[] getAllImages()
          Produces an array with information of images, in ascending order through all the text.
 long getCode()
          Delivers the viewable's code.
 java.lang.String getName()
          Delivers this viewables's name
 int getPrintType()
          Delivers this viewables's print type (Laser or Typewritter)
 boolean hasVariables()
          Decides if this viewable has variables.
 java.util.ArrayList[] setOfVariables()
          Delivers the set of variables of this "viewable".
 java.lang.String toFoTemplate()
          Transform this Viewable in a "fo-template" without external references to image files.
 

Method Detail

getAllImages

public java.util.ArrayList[] getAllImages()
Produces an array with information of images, in ascending order through all the text. The position information is kept but is meaningless in this case.
Returns:
An array of

setOfVariables

public java.util.ArrayList[] setOfVariables()
Delivers the set of variables of this "viewable".
Returns:
Description of the Return Value

getCode

public long getCode()
Delivers the viewable's code.
Returns:
The code value

getName

public java.lang.String getName()
Delivers this viewables's name
Returns:
The name value

getPrintType

public int getPrintType()
Delivers this viewables's print type (Laser or Typewritter)
Returns:
The printType value

hasVariables

public boolean hasVariables()
Decides if this viewable has variables.
Returns:
Description of the Return Value

toFoTemplate

public java.lang.String toFoTemplate()
Transform this Viewable in a "fo-template" without external references to image files.
Returns:
The fo-template --as a String-- or null if something goes wrong.