|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.report.TOC
public abstract class TOC
A TOC object represents a 'table of contents' in a report. The TOC class defines the attributes of the table of contents, such as the font, alignment, indent, leader, etc. A number of predefined table of contents styles are available, and can be used without any programming:
report.addTOC(TOC.FORMAL);If a custom table of contents style is needed, a new class can be derived from the TOC class, or one of the predefined classes.
| Nested Class Summary | |
|---|---|
static class |
TOC.Classic
'Classic' table of contents style. |
static class |
TOC.Default
'Default' table of contents style. |
static class |
TOC.Distinctive
'Distinctive' table of contents style. |
static class |
TOC.Fancy
'Fancy' table of contents style. |
static class |
TOC.Formal
'Formal' table of contents style. |
static class |
TOC.Modern
'Modern' table of contents style. |
static class |
TOC.Simple
'Simple' table of contents style. |
| Field Summary | |
|---|---|
protected Color |
background
|
static TOC |
CLASSIC
'Classic' table of contents style. |
static TOC |
DEFAULT
Default table of contents style. |
protected Font |
defFn
|
static TOC |
DISTINCTIVE
'Distinctive' table of contents style. |
static TOC |
FANCY
'Fancy' table of contents style. |
protected Color |
foreground
|
static TOC |
FORMAL
'Formal' table of contents style. |
protected String |
formatStr
|
static TOC |
MODERN
'Modern' table of contents style. |
static TOC |
SIMPLE
'Simple' table of contents style. |
| Constructor Summary | |
|---|---|
TOC()
Create a TOC class. |
|
| Method Summary | |
|---|---|
Object |
clone()
Make a copy of this object. |
int |
getAlignment(int level)
Get the heading alignment. |
Color |
getBackground()
Get the background color. |
Font |
getBaseFont()
Get the base font of the table of contents. |
Font |
getFont(int level)
Get the font for the toc level. |
Color |
getForeground()
Get the foreground color. |
double |
getIndent(int level)
Get the heading indentation. |
int |
getLeader(int level)
Get the leader style for the toc level. |
Hashtable |
getLevelSpacings()
Get the level spacings. |
String |
getPageFormat()
Get the page number format. |
int |
getSeparator(int level)
Get the separator for the toc level. |
boolean |
isPageNumberRight()
Check if page number should be right aligned. |
void |
setBackground(Color background)
Set the background color. |
void |
setBaseFont(Font font)
Set the base font for the table of contents elements. |
void |
setForeground(Color foreground)
Set the foreground color. |
void |
setLevelSpacings(Hashtable levelSpacing)
Set the level spacings. |
void |
setPageFormat(String format)
Set the page number format. |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Font defFn
protected Color foreground
protected Color background
protected String formatStr
public static final TOC DEFAULT
public static final TOC CLASSIC
public static final TOC DISTINCTIVE
public static final TOC FANCY
public static final TOC MODERN
public static final TOC FORMAL
public static final TOC SIMPLE
| Constructor Detail |
|---|
public TOC()
| Method Detail |
|---|
public void setBaseFont(Font font)
font - base font.public Font getBaseFont()
public Color getForeground()
public void setForeground(Color foreground)
foreground - foreground color.public Color getBackground()
public void setBackground(Color background)
background - background color.public String getPageFormat()
public void setPageFormat(String format)
format - page number format.public Hashtable getLevelSpacings()
public void setLevelSpacings(Hashtable levelSpacing)
levelSpacing - spacings of levels.public double getIndent(int level)
level - the heading level. Starts from 1.
public int getAlignment(int level)
level - the heading level. Starts from 1.
public Font getFont(int level)
level - the heading level. Starts from 1.
public int getSeparator(int level)
level - the heading level. Starts from 1.
public int getLeader(int level)
level - the heading level. Starts from 1.
public boolean isPageNumberRight()
public Object clone()
clone in class Object
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||