This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.swing.text
class TabStop

java.lang.Object extended by javax.swing.text.TabStop
All Implemented Interfaces:
Serializable
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}.

Field Summary
static int ALIGN_BAR
          
static int ALIGN_CENTER
          Characters following tab are positioned such that all following characters up to next tab/newline are centered around the tabs location.
static 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.
static int ALIGN_LEFT
          Character following tab is positioned at location.
static int ALIGN_RIGHT
          Characters following tab are positioned such that all following characters up to next tab/newline end at location.
static int LEAD_DOTS
          
static int LEAD_EQUALS
          
static int LEAD_HYPHENS
          
static int LEAD_NONE
          
static int LEAD_THICKLINE
          
static int LEAD_UNDERLINE
          
 
Constructor Summary
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.
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALIGN_BAR

public static final int ALIGN_BAR

ALIGN_CENTER

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.

ALIGN_DECIMAL

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.

ALIGN_LEFT

public static final int ALIGN_LEFT
Character following tab is positioned at location.

ALIGN_RIGHT

public static final int ALIGN_RIGHT
Characters following tab are positioned such that all following characters up to next tab/newline end at location.

LEAD_DOTS

public static final int LEAD_DOTS

LEAD_EQUALS

public static final int LEAD_EQUALS

LEAD_HYPHENS

public static final int LEAD_HYPHENS

LEAD_NONE

public static final int LEAD_NONE

LEAD_THICKLINE

public static final int LEAD_THICKLINE

LEAD_UNDERLINE

public static final int LEAD_UNDERLINE
Constructor Detail

TabStop

public TabStop(float pos)
Creates a tab at position pos with a default alignment and default leader.

Parameters:
pos

TabStop

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

Parameters:
pos
align
leader
Method Detail

equals

public boolean equals(Object other)
Returns true if the tabs are equal.

Overrides:
equals in class Object
Parameters:
other
Returns:
true if the tabs are equal, otherwise false

getAlignment

public int getAlignment()
Returns the alignment, as an integer, of the tab.

Returns:
the alignment of the tab

getLeader

public int getLeader()
Returns the leader of the tab.

Returns:
the leader of the tab

getPosition

public float getPosition()
Returns the position, as a float, of the tab.

Returns:
the position of the tab

hashCode

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

Overrides:
hashCode in class Object
Returns:
the hashCode for the object

toString

public String toString()
Overrides:
toString in class Object
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.