com.ibm.richtext.awtui
Class TabRuler

java.lang.Object
  |
  +--java.awt.Component
        |
        +--com.ibm.richtext.awtui.TabRuler
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, MTabRulerComponent, java.io.Serializable

public final class TabRuler
extends java.awt.Component
implements MTabRulerComponent

TabRuler is an implementation of MTabRulerComponent in an AWT component.

See Also:
Serialized Form

Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface com.ibm.richtext.awtui.MTabRulerComponent
COPYRIGHT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TabRuler(int baseline, int origin, MTextPanel textPanel)
          Create a new TabRuler.
 
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.
 java.awt.Dimension getMinimumSize()
           
 java.awt.Dimension getPreferredSize()
           
 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 paint(java.awt.Graphics g)
           
 void setBackColor(java.awt.Color backColor)
          Set the background color of this TabRuler.
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getInputContext, getInputMethodRequests, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getName, getParent, getPeer, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TabRuler

public TabRuler(int baseline,
                int origin,
                MTextPanel textPanel)
Create a new TabRuler.
Parameters:
baseline - the y-coordinate of the ruler's baseline
origin - the x-coordinate in this Component where the left margin appears
textPanel - the MTextPanel to listen to. This TabRuler will reflect the MTextPanel's paragraph styles, and update the paragraph styles when manipulated.
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.
Specified by:
listenToTextPanel in interface MTabRulerComponent
Parameters:
textPanel - the MTextPanel to listen to

getBackColor

public java.awt.Color getBackColor()
Return the background color of this TabRuler.
Specified by:
getBackColor in interface MTabRulerComponent
Returns:
the background color of this TabRuler

setBackColor

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

getRuler

public MTabRuler getRuler()
Return the MTabRuler represented by this TabRuler.
Specified by:
getRuler in interface MTabRulerComponent
Returns:
the MTabRuler represented by this TabRuler

getLeadingMargin

public int getLeadingMargin()
Return the leading margin of this TabRuler.
Specified by:
getLeadingMargin in interface MTabRulerComponent
Returns:
the leading margin of this TabRuler

getFirstLineIndent

public int getFirstLineIndent()
Return the first line indent of this TabRuler.
Specified by:
getFirstLineIndent in interface MTabRulerComponent
Returns:
the first line indent of this TabRuler

getTrailingMargin

public final int getTrailingMargin()
Return the trailing margin of this TabRuler.
Specified by:
getTrailingMargin in interface MTabRulerComponent
Returns:
the trailing margin of this TabRuler

paint

public void paint(java.awt.Graphics g)
Overrides:
paint in class java.awt.Component

getPreferredSize

public java.awt.Dimension getPreferredSize()
Overrides:
getPreferredSize in class java.awt.Component

getMinimumSize

public java.awt.Dimension getMinimumSize()
Overrides:
getMinimumSize in class java.awt.Component


Copyright (c) 1998-2000 IBM Corporation and others.