com.aspose.words
Class TabStop

java.lang.Object
    extended by com.aspose.words.TabStop
All Implemented Interfaces:
java.lang.Cloneable

public class TabStop 
extends java.lang.Object

Represents a single custom tab stop. The TabStop object is a member of the TabStopCollection collection.

Normally, a tab stop specifies a position where a tab stop exists. But because tab stops can be inherited from parent styles, it might be needed for the child object to define explicitly that there is no tab stop at a given position. To clear an inherited tab stop at a given position, create a TabStop object and set Alignment to TabAlignment.Clear.

For more information see TabStopCollection.

Example:

Shows how to modify the position of the right tab stop in TOC related paragraphs.
Document doc = new Document(getMyDir() + "Table of contents.docx");

// Iterate through all paragraphs with TOC result-based styles; this is any style between TOC and TOC9.
for (Paragraph para : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
    if (para.getParagraphFormat().getStyle().getStyleIdentifier() >= StyleIdentifier.TOC_1
            && para.getParagraphFormat().getStyle().getStyleIdentifier() <= StyleIdentifier.TOC_9) {
        // Get the first tab used in this paragraph, this should be the tab used to align the page numbers.
        TabStop tab = para.getParagraphFormat().getTabStops().get(0);

        // Replace the first default tab, stop with a custom tab stop.
        para.getParagraphFormat().getTabStops().removeByPosition(tab.getPosition());
        para.getParagraphFormat().getTabStops().add(tab.getPosition() - 50.0, tab.getAlignment(), tab.getLeader());
    }
}

doc.save(getArtifactsDir() + "Styles.ChangeTocsTabStops.docx");
See Also:
ParagraphFormat, TabStopCollection, Document.DefaultTabStop

Constructor Summary
TabStop(double position)
           Initializes a new instance of this class.
TabStop(double position, int alignment, int leader)
           Initializes a new instance of this class.
 
Property Getters/Setters Summary
intgetAlignment()
voidsetAlignment(int value)
           Gets or sets the alignment of text at this tab stop. The value of the property is TabAlignment integer constant.
booleanisClear()
           Returns true if this tab stop clears any existing tab stops in this position.
intgetLeader()
voidsetLeader(int value)
           Gets or sets the type of the leader line displayed under the tab character. The value of the property is TabLeader integer constant.
doublegetPosition()
           Gets the position of the tab stop in points.
 
Method Summary
booleanequals(TabStop rhs)
           Compares with the specified TabStop.
inthashCode()
           Calculates hash code for this object.
 

Constructor Detail

TabStop

public TabStop(double position)
Initializes a new instance of this class.

Example:

Shows how to work with a document's collection of tab stops.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

TabStopCollection tabStops = builder.getParagraphFormat().getTabStops();

// 72 points is one "inch" on the Microsoft Word tab stop ruler.
tabStops.add(new TabStop(72.0));
tabStops.add(new TabStop(432, TabAlignment.RIGHT, TabLeader.DASHES));

Assert.assertEquals(2, tabStops.getCount());
Assert.assertFalse(tabStops.get(0).isClear());
Assert.assertFalse(tabStops.get(0).equals(tabStops.get(1)));

// Every "tab" character takes the builder's cursor to the location of the next tab stop.
builder.writeln("Start\tTab 1\tTab 2");

ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();

Assert.assertEquals(2, paragraphs.getCount());

// Each paragraph gets its tab stop collection, which clones its values from the document builder's tab stop collection.
Assert.assertEquals(paragraphs.get(0).getParagraphFormat().getTabStops(), paragraphs.get(1).getParagraphFormat().getTabStops());

// A tab stop collection can point us to TabStops before and after certain positions.
Assert.assertEquals(72.0, tabStops.before(100.0).getPosition());
Assert.assertEquals(432.0, tabStops.after(100.0).getPosition());

// We can clear a paragraph's tab stop collection to revert to the default tabbing behavior.
paragraphs.get(1).getParagraphFormat().getTabStops().clear();

Assert.assertEquals(0, paragraphs.get(1).getParagraphFormat().getTabStops().getCount());

doc.save(getArtifactsDir() + "TabStopCollection.TabStopCollection.docx");

TabStop

public TabStop(double position, int alignment, int leader)
Initializes a new instance of this class.
Parameters:
position - The position of the tab stop in points.
alignment - A TabAlignment value that specifies the alignment of text at this tab stop.
leader - A TabLeader value that specifies the type of the leader line displayed under the tab character.

Example:

Shows how to work with a document's collection of tab stops.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

TabStopCollection tabStops = builder.getParagraphFormat().getTabStops();

// 72 points is one "inch" on the Microsoft Word tab stop ruler.
tabStops.add(new TabStop(72.0));
tabStops.add(new TabStop(432, TabAlignment.RIGHT, TabLeader.DASHES));

Assert.assertEquals(2, tabStops.getCount());
Assert.assertFalse(tabStops.get(0).isClear());
Assert.assertFalse(tabStops.get(0).equals(tabStops.get(1)));

// Every "tab" character takes the builder's cursor to the location of the next tab stop.
builder.writeln("Start\tTab 1\tTab 2");

ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();

Assert.assertEquals(2, paragraphs.getCount());

// Each paragraph gets its tab stop collection, which clones its values from the document builder's tab stop collection.
Assert.assertEquals(paragraphs.get(0).getParagraphFormat().getTabStops(), paragraphs.get(1).getParagraphFormat().getTabStops());

// A tab stop collection can point us to TabStops before and after certain positions.
Assert.assertEquals(72.0, tabStops.before(100.0).getPosition());
Assert.assertEquals(432.0, tabStops.after(100.0).getPosition());

// We can clear a paragraph's tab stop collection to revert to the default tabbing behavior.
paragraphs.get(1).getParagraphFormat().getTabStops().clear();

Assert.assertEquals(0, paragraphs.get(1).getParagraphFormat().getTabStops().getCount());

doc.save(getArtifactsDir() + "TabStopCollection.TabStopCollection.docx");

Property Getters/Setters Detail

getAlignment/setAlignment

public int getAlignment() / public void setAlignment(int value)
Gets or sets the alignment of text at this tab stop. The value of the property is TabAlignment integer constant.

Example:

Shows how to modify the position of the right tab stop in TOC related paragraphs.
Document doc = new Document(getMyDir() + "Table of contents.docx");

// Iterate through all paragraphs with TOC result-based styles; this is any style between TOC and TOC9.
for (Paragraph para : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
    if (para.getParagraphFormat().getStyle().getStyleIdentifier() >= StyleIdentifier.TOC_1
            && para.getParagraphFormat().getStyle().getStyleIdentifier() <= StyleIdentifier.TOC_9) {
        // Get the first tab used in this paragraph, this should be the tab used to align the page numbers.
        TabStop tab = para.getParagraphFormat().getTabStops().get(0);

        // Replace the first default tab, stop with a custom tab stop.
        para.getParagraphFormat().getTabStops().removeByPosition(tab.getPosition());
        para.getParagraphFormat().getTabStops().add(tab.getPosition() - 50.0, tab.getAlignment(), tab.getLeader());
    }
}

doc.save(getArtifactsDir() + "Styles.ChangeTocsTabStops.docx");

isClear

public boolean isClear()
Returns true if this tab stop clears any existing tab stops in this position.

Example:

Shows how to work with a document's collection of tab stops.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

TabStopCollection tabStops = builder.getParagraphFormat().getTabStops();

// 72 points is one "inch" on the Microsoft Word tab stop ruler.
tabStops.add(new TabStop(72.0));
tabStops.add(new TabStop(432, TabAlignment.RIGHT, TabLeader.DASHES));

Assert.assertEquals(2, tabStops.getCount());
Assert.assertFalse(tabStops.get(0).isClear());
Assert.assertFalse(tabStops.get(0).equals(tabStops.get(1)));

// Every "tab" character takes the builder's cursor to the location of the next tab stop.
builder.writeln("Start\tTab 1\tTab 2");

ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();

Assert.assertEquals(2, paragraphs.getCount());

// Each paragraph gets its tab stop collection, which clones its values from the document builder's tab stop collection.
Assert.assertEquals(paragraphs.get(0).getParagraphFormat().getTabStops(), paragraphs.get(1).getParagraphFormat().getTabStops());

// A tab stop collection can point us to TabStops before and after certain positions.
Assert.assertEquals(72.0, tabStops.before(100.0).getPosition());
Assert.assertEquals(432.0, tabStops.after(100.0).getPosition());

// We can clear a paragraph's tab stop collection to revert to the default tabbing behavior.
paragraphs.get(1).getParagraphFormat().getTabStops().clear();

Assert.assertEquals(0, paragraphs.get(1).getParagraphFormat().getTabStops().getCount());

doc.save(getArtifactsDir() + "TabStopCollection.TabStopCollection.docx");

getLeader/setLeader

public int getLeader() / public void setLeader(int value)
Gets or sets the type of the leader line displayed under the tab character. The value of the property is TabLeader integer constant.

Example:

Shows how to modify the position of the right tab stop in TOC related paragraphs.
Document doc = new Document(getMyDir() + "Table of contents.docx");

// Iterate through all paragraphs with TOC result-based styles; this is any style between TOC and TOC9.
for (Paragraph para : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
    if (para.getParagraphFormat().getStyle().getStyleIdentifier() >= StyleIdentifier.TOC_1
            && para.getParagraphFormat().getStyle().getStyleIdentifier() <= StyleIdentifier.TOC_9) {
        // Get the first tab used in this paragraph, this should be the tab used to align the page numbers.
        TabStop tab = para.getParagraphFormat().getTabStops().get(0);

        // Replace the first default tab, stop with a custom tab stop.
        para.getParagraphFormat().getTabStops().removeByPosition(tab.getPosition());
        para.getParagraphFormat().getTabStops().add(tab.getPosition() - 50.0, tab.getAlignment(), tab.getLeader());
    }
}

doc.save(getArtifactsDir() + "Styles.ChangeTocsTabStops.docx");

getPosition

public double getPosition()
Gets the position of the tab stop in points.

Example:

Shows how to modify the position of the right tab stop in TOC related paragraphs.
Document doc = new Document(getMyDir() + "Table of contents.docx");

// Iterate through all paragraphs with TOC result-based styles; this is any style between TOC and TOC9.
for (Paragraph para : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
    if (para.getParagraphFormat().getStyle().getStyleIdentifier() >= StyleIdentifier.TOC_1
            && para.getParagraphFormat().getStyle().getStyleIdentifier() <= StyleIdentifier.TOC_9) {
        // Get the first tab used in this paragraph, this should be the tab used to align the page numbers.
        TabStop tab = para.getParagraphFormat().getTabStops().get(0);

        // Replace the first default tab, stop with a custom tab stop.
        para.getParagraphFormat().getTabStops().removeByPosition(tab.getPosition());
        para.getParagraphFormat().getTabStops().add(tab.getPosition() - 50.0, tab.getAlignment(), tab.getLeader());
    }
}

doc.save(getArtifactsDir() + "Styles.ChangeTocsTabStops.docx");

Method Detail

equals

public boolean equals(TabStop rhs)
Compares with the specified TabStop.

Example:

Shows how to work with a document's collection of tab stops.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

TabStopCollection tabStops = builder.getParagraphFormat().getTabStops();

// 72 points is one "inch" on the Microsoft Word tab stop ruler.
tabStops.add(new TabStop(72.0));
tabStops.add(new TabStop(432, TabAlignment.RIGHT, TabLeader.DASHES));

Assert.assertEquals(2, tabStops.getCount());
Assert.assertFalse(tabStops.get(0).isClear());
Assert.assertFalse(tabStops.get(0).equals(tabStops.get(1)));

// Every "tab" character takes the builder's cursor to the location of the next tab stop.
builder.writeln("Start\tTab 1\tTab 2");

ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();

Assert.assertEquals(2, paragraphs.getCount());

// Each paragraph gets its tab stop collection, which clones its values from the document builder's tab stop collection.
Assert.assertEquals(paragraphs.get(0).getParagraphFormat().getTabStops(), paragraphs.get(1).getParagraphFormat().getTabStops());

// A tab stop collection can point us to TabStops before and after certain positions.
Assert.assertEquals(72.0, tabStops.before(100.0).getPosition());
Assert.assertEquals(432.0, tabStops.after(100.0).getPosition());

// We can clear a paragraph's tab stop collection to revert to the default tabbing behavior.
paragraphs.get(1).getParagraphFormat().getTabStops().clear();

Assert.assertEquals(0, paragraphs.get(1).getParagraphFormat().getTabStops().getCount());

doc.save(getArtifactsDir() + "TabStopCollection.TabStopCollection.docx");

hashCode

public int hashCode()
Calculates hash code for this object.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.