StyledTextPrintOptions

Use StyledTextPrintOptions to specify printing options for the StyledText.print(Printer, StyledTextPrintOptions) API. The following example prints a right aligned page number in the footer, sets the job name to "Example" and prints line background colors but no other formatting: <pre> StyledTextPrintOptions options = new StyledTextPrintOptions(); options.footer = "\t\t<page>"; options.jobName = "Example"; options.printLineBackground = true;

Runnable runnable = styledText.print(new Printer(), options); runnable.run(); </pre>

@see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

@since 2.1

class StyledTextPrintOptions {

bool printTextForeground;

bool printTextBackground;

bool printTextFontStyle;

bool printLineBackground;

bool printLineNumbers;

String[] lineLabels;

}

Members

Static variables

PAGE_TAG String PAGE_TAG;: Page number placeholder constant for use in <code>header</code> and <code>footer</code>. Value is <code><page></code>
SEPARATOR String SEPARATOR;: Separator constant for use in <code>header</code> and <code>footer</code>. Value is <code>\t</code>

Variables

footer String footer;: Formatted text to print in the footer of each page. "left '\t' center '\t' right" left, center, right = <page> | #CDATA Header and footer are defined as three separate regions for arbitrary text or the page number placeholder <page> (<code>StyledTextPrintOptions.PAGE_TAG</code>). The three regions are left aligned, centered and right aligned. They are separated by a tab character (<code>StyledTextPrintOptions.SEPARATOR</code>).
header String header;: Formatted text to print in the header of each page. "left '\t' center '\t' right" left, center, right = <page> | #CDATA Header and footer are defined as three separate regions for arbitrary text or the page number placeholder <page> (<code>StyledTextPrintOptions.PAGE_TAG</code>). The three regions are left aligned, centered and right aligned. They are separated by a tab character (<code>StyledTextPrintOptions.SEPARATOR</code>).
jobName String jobName;: Name of the print job.
lineLabels String[] lineLabels;: Labels used for printing line numbers.
printLineBackground bool printLineBackground;: Print the line background color. Default value is <code>false</code>.
printLineNumbers bool printLineNumbers;: Print line numbers. Default value is <code>false</code>.
printTextBackground bool printTextBackground;: Print the text background color. Default value is <code>false</code>.
printTextFontStyle bool printTextFontStyle;: Print the font styles. Default value is <code>false</code>.
printTextForeground bool printTextForeground;: Print the text foreground color. Default value is <code>false</code>.

StyledTextPrintOptions

Members

Static variables

Variables

Meta

Source