FileDocCategorySizeDatePackage
TabStop.javaAPI DocJava SE 5 API4757Fri Aug 26 14:58:16 BST 2005javax.swing.text

TabStop

public class TabStop extends Object implements Serializable
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 {@link java.beans.XMLEncoder}.

version
1.20 12/19/03

Fields Summary
public static final int
ALIGN_LEFT
Character following tab is positioned at location.
public static final int
ALIGN_RIGHT
Characters following tab are positioned such that all following characters up to next tab/newline end at location.
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.
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.
public static final int
ALIGN_BAR
public static final int
LEAD_NONE
public static final int
LEAD_DOTS
public static final int
LEAD_HYPHENS
public static final int
LEAD_UNDERLINE
public static final int
LEAD_THICKLINE
public static final int
LEAD_EQUALS
private int
alignment
Tab type.
private float
position
Location, from the left margin, that tab is at.
private int
leader
Constructors Summary
public TabStop(float pos)
Creates a tab at position pos with a default alignment and default leader.


                      
       
        this(pos, ALIGN_LEFT, LEAD_NONE);
public TabStop(float pos, int align, int leader)
Creates a tab with the specified position pos, alignment align and leader leader.

	alignment = align;
	this.leader = leader;
	position = pos;
Methods Summary
public booleanequals(java.lang.Object other)
Returns true if the tabs are equal.

return
true if the tabs are equal, otherwise false

	if (other == this) {
	    return true;
	}
	if (other instanceof TabStop) {
	    TabStop o = (TabStop)other;
	    return ( (alignment == o.alignment) &&
		     (leader == o.leader) &&
		     (position == o.position) );  /* TODO: epsilon */
	}
	return false;
public intgetAlignment()
Returns the alignment, as an integer, of the tab.

return
the alignment of the tab

	return alignment;
public intgetLeader()
Returns the leader of the tab.

return
the leader of the tab

	return leader;
public floatgetPosition()
Returns the position, as a float, of the tab.

return
the position of the tab

	return position;
public inthashCode()
Returns the hashCode for the object. This must be defined here to ensure 100% pure.

return
the hashCode for the object

 
	return alignment ^ leader ^ Math.round(position);
public java.lang.StringtoString()

	String buf;
	switch(alignment) {
	  default:
	  case ALIGN_LEFT:
	    buf = "";
	    break;
	  case ALIGN_RIGHT:
	    buf = "right ";
	    break;
	  case ALIGN_CENTER:
	    buf = "center ";
	    break;
	  case ALIGN_DECIMAL:
	    buf = "decimal ";
	    break;
	  case ALIGN_BAR:
	    buf = "bar ";
	    break;
	}
	buf = buf + "tab @" + String.valueOf(position);
	if (leader != LEAD_NONE)
	    buf = buf + " (w/leaders)";
	return buf;