public class

TabStop

extends Object
implements Serializable
java.lang.Object
   ↳ javax.swing.text.TabStop

Class Overview

This class encapsulates a single tab stop (basically as tab stops are thought of by RTF). A tab stop is at a specified distance from the left margin, aligns text in a specified way, and has a specified leader. TabStops are immutable, and usually contained in TabSets.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Summary

Constants
int ALIGN_BAR
int ALIGN_CENTER Characters following tab are positioned such that all following characters up to next tab/newline are centered around the tabs location.
int ALIGN_DECIMAL Characters following tab are aligned such that next decimal/tab/newline is at the tab location, very similar to RIGHT_TAB, just includes decimal as additional character to look for.
int ALIGN_LEFT Character following tab is positioned at location.
int ALIGN_RIGHT Characters following tab are positioned such that all following characters up to next tab/newline end at location.
int LEAD_DOTS
int LEAD_EQUALS
int LEAD_HYPHENS
int LEAD_NONE
int LEAD_THICKLINE
int LEAD_UNDERLINE
Public Constructors
TabStop(float pos)
Creates a tab at position pos with a default alignment and default leader.
TabStop(float pos, int align, int leader)
Creates a tab with the specified position pos, alignment align and leader leader.
Public Methods
boolean equals(Object other)
Returns true if the tabs are equal.
int getAlignment()
Returns the alignment, as an integer, of the tab.
int getLeader()
Returns the leader of the tab.
float getPosition()
Returns the position, as a float, of the tab.
int hashCode()
Returns the hashCode for the object.
String toString()
Returns a string representation of the object.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int ALIGN_BAR

Constant Value: 5 (0x00000005)

public static final int ALIGN_CENTER

Characters following tab are positioned such that all following characters up to next tab/newline are centered around the tabs location.

Constant Value: 2 (0x00000002)

public static final int ALIGN_DECIMAL

Characters following tab are aligned such that next decimal/tab/newline is at the tab location, very similar to RIGHT_TAB, just includes decimal as additional character to look for.

Constant Value: 4 (0x00000004)

public static final int ALIGN_LEFT

Character following tab is positioned at location.

Constant Value: 0 (0x00000000)

public static final int ALIGN_RIGHT

Characters following tab are positioned such that all following characters up to next tab/newline end at location.

Constant Value: 1 (0x00000001)

public static final int LEAD_DOTS

Constant Value: 1 (0x00000001)

public static final int LEAD_EQUALS

Constant Value: 5 (0x00000005)

public static final int LEAD_HYPHENS

Constant Value: 2 (0x00000002)

public static final int LEAD_NONE

Constant Value: 0 (0x00000000)

public static final int LEAD_THICKLINE

Constant Value: 4 (0x00000004)

public static final int LEAD_UNDERLINE

Constant Value: 3 (0x00000003)

Public Constructors

public TabStop (float pos)

Creates a tab at position pos with a default alignment and default leader.

public TabStop (float pos, int align, int leader)

Creates a tab with the specified position pos, alignment align and leader leader.

Public Methods

public boolean equals (Object other)

Returns true if the tabs are equal.

Parameters
other the reference object with which to compare.
Returns
  • true if the tabs are equal, otherwise false

public int getAlignment ()

Returns the alignment, as an integer, of the tab.

Returns
  • the alignment of the tab

public int getLeader ()

Returns the leader of the tab.

Returns
  • the leader of the tab

public float getPosition ()

Returns the position, as a float, of the tab.

Returns
  • the position of the tab

public int hashCode ()

Returns the hashCode for the object. This must be defined here to ensure 100% pure.

Returns
  • the hashCode for the object

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
  • a string representation of the object.