com.aspose.words

Class TabAlignment

java.lang.Object

com.aspose.words.TabAlignment

public class TabAlignment
extends java.lang.Object

Specifies the alignment/type of a tab stop.

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	BAR Draws a vertical bar at the tab stop position.
static int	CENTER Centers the text around the tab stop.
static int	CLEAR Clears any tab stop in this position.
static int	DECIMAL Aligns the text at the decimal dot.
static int	LEFT Left-aligns the text after the tab stop.
static int	length
static int	LIST The tab is a delimiter between the number/bullet and text in a list item.
static int	RIGHT Right-aligns the text at the tab stop.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

LEFT

public static int LEFT

Left-aligns the text after the tab stop.

CENTER

public static int CENTER

Centers the text around the tab stop.

RIGHT

public static int RIGHT

Right-aligns the text at the tab stop.

DECIMAL

public static int DECIMAL

Aligns the text at the decimal dot.

BAR

public static int BAR

Draws a vertical bar at the tab stop position.

LIST

public static int LIST

The tab is a delimiter between the number/bullet and text in a list item.

CLEAR

public static int CLEAR

Clears any tab stop in this position.

length

public static int length

Method Detail

getName

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

toString

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

fromName

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

getValues

public static int[] getValues()