com.aspose.words

Class TabLeader

java.lang.Object

com.aspose.words.TabLeader

public class TabLeader
extends java.lang.Object

Specifies the type of the leader line displayed under the tab character.

Examples:

Shows how to set custom tab stops for a paragraph.

 
 Document doc = new Document();
 Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();

 // If we are in a paragraph with no tab stops in this collection,
 // the cursor will jump 36 points each time we press the Tab key in Microsoft Word.
 Assert.assertEquals(0, doc.getFirstSection().getBody().getFirstParagraph().getEffectiveTabStops().length);

 // We can add custom tab stops in Microsoft Word if we enable the ruler via the "View" tab.
 // Each unit on this ruler is two default tab stops, which is 72 points.
 // We can add custom tab stops programmatically like this.
 TabStopCollection tabStops = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getTabStops();
 tabStops.add(72.0, TabAlignment.LEFT, TabLeader.DOTS);
 tabStops.add(216.0, TabAlignment.CENTER, TabLeader.DASHES);
 tabStops.add(360.0, TabAlignment.RIGHT, TabLeader.LINE);

 // We can see these tab stops in Microsoft Word by enabling the ruler via "View" -> "Show" -> "Ruler".
 Assert.assertEquals(3, para.getEffectiveTabStops().length);

 // Any tab characters we add will make use of the tab stops on the ruler and may,
 // depending on the tab leader's value, leave a line between the tab departure and arrival destinations.
 para.appendChild(new Run(doc, "\tTab 1\tTab 2\tTab 3"));

 doc.save(getArtifactsDir() + "Paragraph.TabStops.docx");
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	DASHES The leader line is made up from dashes.
static int	DOTS The leader line is made up from dots.
static int	HEAVY The leader line is a single thick line.
static int	length
static int	LINE The leader line is a single line.
static int	MIDDLE_DOT The leader line is made up from middle-dots.
static int	NONE No leader line is displayed.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String tabLeaderName)
static java.lang.String	getName(int tabLeader)
static int[]	getValues()
static java.lang.String	toString(int tabLeader)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static int NONE

No leader line is displayed.

DOTS

public static int DOTS

The leader line is made up from dots.

DASHES

public static int DASHES

The leader line is made up from dashes.

LINE

public static int LINE

The leader line is a single line.

HEAVY

public static int HEAVY

The leader line is a single thick line.

MIDDLE_DOT

public static int MIDDLE_DOT

The leader line is made up from middle-dots.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int tabLeader)

toString

public static java.lang.String toString(int tabLeader)

fromName

public static int fromName(java.lang.String tabLeaderName)

getValues

public static int[] getValues()