SWT LPEX
v3.0.5

com.ibm.lpex.core
Class LpexWindow

java.lang.Object
  extended byorg.eclipse.swt.widgets.Widget
      extended byorg.eclipse.swt.widgets.Control
          extended byorg.eclipse.swt.widgets.Scrollable
              extended byorg.eclipse.swt.widgets.Composite
                  extended bycom.ibm.lpex.core.LpexWindow
All Implemented Interfaces:
Drawable

public class LpexWindow
extends Composite

This class manages an LPEX window. LpexWindow is an SWT Composite consisting of the text window (the edit area), a title line, a status line, a format line (horizontal ruler), a message line, a command line, an optional compare area, and several separator lines positioned in-between various components.

See Also:
LpexView, LpexMultiWindow

Field Summary
 
Fields inherited from class org.eclipse.swt.widgets.Control
handle
 
Constructor Summary
LpexWindow(Composite parent)
          Constructs a window for displaying an LPEX view.
LpexWindow(Composite parent, int swtStyles)
          Constructs a window for displaying an LPEX view.
 
Method Summary
 Composite commandLine()
          Returns the command line.
 Composite compareLine()
          Returns the compare line, or null if none was created yet.
protected  Layout createLayoutManager()
          Creates the layout manager for this LPEX window.
 Composite formatLine()
          Returns the format line.
 LpexView getLpexView()
          Returns the document view currently associated with this window.
 ScrollBar horizontalScrollBar()
          Returns the horizontal scrollbar.
 Composite messageLine()
          Returns the message line.
 Composite separator0()
          Returns the 1st separator line.
 Composite separator1()
          Returns the 2nd separator line.
 Composite separator2()
          Returns the 3rd separator line.
 boolean setFocus()
          Sets the focus on this LpexWindow.
 Composite statusLine()
          Returns the status line.
 Composite textWindow()
          Returns the client portion of the LPEX window (the edit area).
 Composite titleLine()
          Returns the title line.
 ScrollBar verticalScrollBar()
          Returns the vertical scrollbar.
 LpexView view()
          Returns the document view currently associated with this window.
 
Methods inherited from class org.eclipse.swt.widgets.Composite
checkSubclass, computeSize, getChildren, getLayout, getTabList, layout, layout, setLayout, setTabList
 
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getClientArea, getHorizontalBar, getVerticalBar
 
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBackground, setBounds, setBounds, setCapture, setCursor, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LpexWindow

public LpexWindow(Composite parent)
Constructs a window for displaying an LPEX view.


LpexWindow

public LpexWindow(Composite parent,
                  int swtStyles)
Constructs a window for displaying an LPEX view. SWT styles (such as SWT.BORDER) may be passed in, to be used in building this Composite.

Method Detail

titleLine

public Composite titleLine()
Returns the title line.


statusLine

public Composite statusLine()
Returns the status line.


separator0

public Composite separator0()
Returns the 1st separator line.


formatLine

public Composite formatLine()
Returns the format line.


separator1

public Composite separator1()
Returns the 2nd separator line.


textWindow

public Composite textWindow()
Returns the client portion of the LPEX window (the edit area).


horizontalScrollBar

public ScrollBar horizontalScrollBar()
Returns the horizontal scrollbar. The horizontal scrollbar is a widget of the text window, and does not participate as a separate control in the LpexWindow layout.


verticalScrollBar

public ScrollBar verticalScrollBar()
Returns the vertical scrollbar. The vertical scrollbar is a widget of the text window, and does not participate as a separate control in the LpexWindow layout.


separator2

public Composite separator2()
Returns the 3rd separator line.


messageLine

public Composite messageLine()
Returns the message line.


commandLine

public Composite commandLine()
Returns the command line.


compareLine

public Composite compareLine()
Returns the compare line, or null if none was created yet.


createLayoutManager

protected Layout createLayoutManager()
Creates the layout manager for this LPEX window.


view

public LpexView view()
Returns the document view currently associated with this window. This method will be deprecated in favor of the identical #getLpexView().


getLpexView

public LpexView getLpexView()
Returns the document view currently associated with this window.


setFocus

public boolean setFocus()
Sets the focus on this LpexWindow.


SWT LPEX
v3.0.5

(C) Copyright IBM Corporation 1998, 2005.  All Rights Reserved.