com.ibm.richtext.awtui
Interface MTabRulerComponent

All Known Implementing Classes:
TabRuler, JTabRuler

public interface MTabRulerComponent

MTabRulerComponent is implemented by components which provide a tab-ruler interface for interacting with an MTextPanel.

Users interact with MTabRulerComponent implementations as follows:

MTabRulerComponent's appearance will reflect the paragraph styles in the first selected paragraph. Style changes performed with an MTabRulerComponent will apply to all selected paragraphs.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.awt.Color getBackColor()
          Return the background color of this TabRuler.
 int getFirstLineIndent()
          Return the first line indent of this TabRuler.
 int getLeadingMargin()
          Return the leading margin of this TabRuler.
 MTabRuler getRuler()
          Return the MTabRuler represented by this TabRuler.
 int getTrailingMargin()
          Return the trailing margin of this TabRuler.
 void listenToTextPanel(MTextPanel textPanel)
          Listen to the given MTextPanel and reflect its changes, and update its paragraph styles when TabRuler is manipulated.
 void setBackColor(java.awt.Color backColor)
          Set the background color of this TabRuler.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Method Detail

listenToTextPanel

public void listenToTextPanel(MTextPanel textPanel)
Listen to the given MTextPanel and reflect its changes, and update its paragraph styles when TabRuler is manipulated.
Parameters:
textPanel - the MTextPanel to listen to

getBackColor

public java.awt.Color getBackColor()
Return the background color of this TabRuler.
Returns:
the background color of this TabRuler

setBackColor

public void setBackColor(java.awt.Color backColor)
Set the background color of this TabRuler.
Parameters:
backColor - the new background color of this TabRuler

getRuler

public MTabRuler getRuler()
Return the MTabRuler represented by this TabRuler.
Returns:
the MTabRuler represented by this TabRuler

getLeadingMargin

public int getLeadingMargin()
Return the leading margin of this TabRuler.
Returns:
the leading margin of this TabRuler

getFirstLineIndent

public int getFirstLineIndent()
Return the first line indent of this TabRuler.
Returns:
the first line indent of this TabRuler

getTrailingMargin

public int getTrailingMargin()
Return the trailing margin of this TabRuler.
Returns:
the trailing margin of this TabRuler


Copyright (c) 2001 IBM Corporation and others.