LPEX
3.6.8

com.ibm.lpex.core
Class LpexWindow

java.lang.Object
  extended by Composite
      extended by com.ibm.lpex.core.LpexWindow

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

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.
 boolean getForceNoScrollBars()
          Returns the enablement of scroll bars display.
 LpexView getLpexView()
          Returns the document view currently associated with this window.
 ScrollBar horizontalScrollBar()
          Returns the horizontal scrollbar.
protected  boolean isCommandLineOnTop()
          Display the command line on top instead of on bottom of window
 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.
protected  void setCommandLineOnTop(boolean _commandLineOnTop)
          Display the command line on top instead of on bottom of window
 boolean setFocus()
          Sets the focus on this LpexWindow.
 void setForceNoScrollBars(boolean forceNoScrollBars)
          Disables the display of scroll bars.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 window.

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.


setForceNoScrollBars

public void setForceNoScrollBars(boolean forceNoScrollBars)
Disables the display of scroll bars. When using LPEX as a text widget (for example, a single editable text line in a window such as command line's EditLine dialog), we don't want scroll bars to be displayed under any circumstances. The caller in this case must scroll explicitly in order to bring the cursor or the selected section into view.


getForceNoScrollBars

public boolean getForceNoScrollBars()
Returns the enablement of scroll bars display.

See Also:
setForceNoScrollBars(boolean)

createLayoutManager

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


getLpexView

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

Returns:
the view associated with this window, or null if none

setFocus

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


setCommandLineOnTop

protected void setCommandLineOnTop(boolean _commandLineOnTop)
Display the command line on top instead of on bottom of window

Parameters:
_commandLineOnTop - the _commandLineOnTop to set

isCommandLineOnTop

protected boolean isCommandLineOnTop()
Display the command line on top instead of on bottom of window

Returns:
the _commandLineOnTop

LPEX
3.6.8

Copyright © 2013 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.