OutlineLevel
Contents
[
Hide
]Inheritance: java.lang.Object
public class OutlineLevel
Specifies the outline level of a paragraph in the document.
Examples:
Shows how to configure paragraph outline levels to create collapsible text.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Each paragraph has an OutlineLevel, which could be any number from 1 to 9, or at the default "BodyText" value.
// Setting the property to one of the numbered values will show an arrow to the left
// of the beginning of the paragraph.
builder.getParagraphFormat().setOutlineLevel(OutlineLevel.LEVEL_1);
builder.writeln("Paragraph outline level 1.");
// Level 1 is the topmost level. If there is a paragraph with a lower level below a paragraph with a higher level,
// collapsing the higher-level paragraph will collapse the lower level paragraph.
builder.getParagraphFormat().setOutlineLevel(OutlineLevel.LEVEL_2);
builder.writeln("Paragraph outline level 2.");
// Two paragraphs of the same level will not collapse each other,
// and the arrows do not collapse the paragraphs they point to.
builder.getParagraphFormat().setOutlineLevel(OutlineLevel.LEVEL_3);
builder.writeln("Paragraph outline level 3.");
builder.writeln("Paragraph outline level 3.");
// The default "BodyText" value is the lowest, which a paragraph of any level can collapse.
builder.getParagraphFormat().setOutlineLevel(OutlineLevel.BODY_TEXT);
builder.writeln("Paragraph at main text level.");
doc.save(getArtifactsDir() + "ParagraphFormat.ParagraphOutlineLevel.docx");
Fields
| Field | Description |
|---|---|
| BODY_TEXT | The paragraph is at the level of the main text. |
| LEVEL_1 | The paragraph is at the outline level 1 (topmost level). |
| LEVEL_2 | The paragraph is at the outline level 2. |
| LEVEL_3 | The paragraph is at the outline level 3. |
| LEVEL_4 | The paragraph is at the outline level 4. |
| LEVEL_5 | The paragraph is at the outline level 5. |
| LEVEL_6 | The paragraph is at the outline level 6. |
| LEVEL_7 | The paragraph is at the outline level 7. |
| LEVEL_8 | The paragraph is at the outline level 8. |
| LEVEL_9 | The paragraph is at the outline level 9. |
| length |
Methods
| Method | Description |
|---|---|
| fromName(String outlineLevelName) | |
| getName(int outlineLevel) | |
| getValues() | |
| toString(int outlineLevel) |
BODY_TEXT
public static int BODY_TEXT
The paragraph is at the level of the main text.
LEVEL_1
public static int LEVEL_1
The paragraph is at the outline level 1 (topmost level).
LEVEL_2
public static int LEVEL_2
The paragraph is at the outline level 2.
LEVEL_3
public static int LEVEL_3
The paragraph is at the outline level 3.
LEVEL_4
public static int LEVEL_4
The paragraph is at the outline level 4.
LEVEL_5
public static int LEVEL_5
The paragraph is at the outline level 5.
LEVEL_6
public static int LEVEL_6
The paragraph is at the outline level 6.
LEVEL_7
public static int LEVEL_7
The paragraph is at the outline level 7.
LEVEL_8
public static int LEVEL_8
The paragraph is at the outline level 8.
LEVEL_9
public static int LEVEL_9
The paragraph is at the outline level 9.
length
public static int length
fromName(String outlineLevelName)
public static int fromName(String outlineLevelName)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| outlineLevelName | java.lang.String |
Returns: int
getName(int outlineLevel)
public static String getName(int outlineLevel)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| outlineLevel | int |
Returns: java.lang.String
getValues()
public static int[] getValues()
Returns: int[]
toString(int outlineLevel)
public static String toString(int outlineLevel)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| outlineLevel | int |
Returns: java.lang.String
