com.ibm.retail.saf.provider
Interface PrintLine

All Superinterfaces:
POSInfo, java.io.Serializable
All Known Implementing Classes:
Default4690PrintLine

public interface PrintLine
extends POSInfo

PrintLine provides access to the line that was sent to the point-of-sale printer by the POS application.

The line is available as filtered text along with format getter methods andalso as raw text with the printer control characters embedded in the string.

The filtered text string contains print line text including the spacing and blank lines, but printer attributes such as emphasized or double-high text are removed from the string and made available in getter methods.

The raw text string contains an embedded representation of the printer control characters (escape sequences) that are used by the POS application to indicate text attributes such as bold text and font sizes.


Field Summary
static int FONT_BOLD
           
static int FONT_DOUBLE_WIDE
           
static int FONT_DOUBLE_WIDE_BOLD
           
static int FONT_DOUBLE_WIDE_DOUBLE_HIGH
           
static int FONT_DOUBLE_WIDE_DOUBLE_HIGH_BOLD
           
static int FONT_MEDIUM
           
static int FONT_MEDIUM_WIDE_BOLD
           
static int FONT_NORMAL
           
 
Method Summary
 int getFont()
          Returns a font value
 int getLineFeedCount()
          Returns a count of the number of line feeds to insert after line
 java.lang.String getRawText()
          Returns a text string containing embedded print control characters used by POS
 java.lang.String getText()
          Returns a filtered text string containing just printable text
 boolean isCentered()
          Returns a boolean that determines whether line should be centered
 boolean isCut()
          Returns a boolean that determines whether a paper cut should be done after line
 
Methods inherited from interface com.ibm.retail.saf.provider.POSInfo
getExtendedAttribute, getExtendedAttributeNames, removeExtendedAttribute, setExtendedAttribute
 

Field Detail

FONT_NORMAL

public static final int FONT_NORMAL
See Also:
Constant Field Values

FONT_MEDIUM

public static final int FONT_MEDIUM
See Also:
Constant Field Values

FONT_DOUBLE_WIDE

public static final int FONT_DOUBLE_WIDE
See Also:
Constant Field Values

FONT_DOUBLE_WIDE_DOUBLE_HIGH

public static final int FONT_DOUBLE_WIDE_DOUBLE_HIGH
See Also:
Constant Field Values

FONT_BOLD

public static final int FONT_BOLD
See Also:
Constant Field Values

FONT_MEDIUM_WIDE_BOLD

public static final int FONT_MEDIUM_WIDE_BOLD
See Also:
Constant Field Values

FONT_DOUBLE_WIDE_BOLD

public static final int FONT_DOUBLE_WIDE_BOLD
See Also:
Constant Field Values

FONT_DOUBLE_WIDE_DOUBLE_HIGH_BOLD

public static final int FONT_DOUBLE_WIDE_DOUBLE_HIGH_BOLD
See Also:
Constant Field Values
Method Detail

getText

public java.lang.String getText()
Returns a filtered text string containing just printable text

Returns:
print line string

getFont

public int getFont()
Returns a font value

Returns:
integer representing font to use for the line

isCentered

public boolean isCentered()
Returns a boolean that determines whether line should be centered

Returns:
boolean

getLineFeedCount

public int getLineFeedCount()
Returns a count of the number of line feeds to insert after line

Returns:
integer representing line feed count

getRawText

public java.lang.String getRawText()
Returns a text string containing embedded print control characters used by POS

Returns:
raw print line string

isCut

public boolean isCut()
Returns a boolean that determines whether a paper cut should be done after line

Returns:
boolean