public class TdbKernelWindow extends TdbMessageProvider implements com.tietoenator.trip.jxp.internal.utils.DOMSink
Constructor and Description |
---|
TdbKernelWindow(TdbSession session)
Constructor, doesn't create a server buffer
|
TdbKernelWindow(TdbSession session,
TdbKernelWindowType type)
Constructor, creates a new kernel window buffer on the server with dimensions 20x80
|
TdbKernelWindow(TdbSession session,
TdbKernelWindowType type,
int rows,
int cols)
Constructor, creates a new kernel window buffer on the server.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clear the local buffer
|
void |
close()
Close the kernel window, release any associated resources on both client and server.
|
int |
getId()
Retrieve the ID of the window
|
TdbKernelWindowType |
getType()
Retrieve the type of the window
|
java.lang.String |
getTypeName()
Retrieve the XML name of the window
|
java.util.List<TdbHitPoint> |
hits()
Retrieve any hit points relevant to the current buffer.
|
boolean |
isAtBottom()
Check if the window is positioned at the "bottom" of the available output
|
boolean |
isAtTop()
Check if the window is positioned at the "top" of the available output
|
boolean |
isFocused()
Check if the window contains focus points (Show FOCus output)
|
boolean |
isScrollingWindow()
Check if the window is using scrolling output or replaced output
|
java.util.List<java.lang.String> |
lines()
Retrieve the most recent update to the buffer.
|
void |
scrollDown()
Scroll the buffer "down" a "page" at a time.
|
void |
scrollNext()
Scroll the buffer "down" so that the next record after the last currently being
displayed in the buffer is at the top of the buffer.
|
void |
scrollPrevious()
Scroll the buffer "up" so that the previous record before the topmost
currently being displayed in the buffer is at the top of the buffer.
|
void |
scrollUp()
Scroll the buffer "up" a "page" at a time.
|
java.lang.String |
toFormattedString(java.lang.String before,
java.lang.String after,
java.lang.String linebreak)
Create a formatted string from the buffer's current contents.
|
java.lang.String |
toString()
Overrides the default to provide the text content of the window buffer,
lines delimited with newlines, hit points not marked up.
|
codeList, getLastCode, getLastMessage, hasMessages, messageList, resetMessages
cancel, getSession, isCancelable, setCancelable
public TdbKernelWindow(TdbSession session, TdbKernelWindowType type, int rows, int cols) throws TdbException
session
- Active sessiontype
- Window typerows
- Vertical dimension of the buffer to createcols
- Horizontal dimension of the buffer to createTdbException
public TdbKernelWindow(TdbSession session, TdbKernelWindowType type) throws TdbException
session
- Active sessiontype
- Wndow typeTdbException
public TdbKernelWindow(TdbSession session) throws TdbException
session
- Active sessionTdbException
public java.lang.String getTypeName()
public TdbKernelWindowType getType()
public int getId()
public boolean isAtTop()
public boolean isAtBottom()
public boolean isScrollingWindow()
public boolean isFocused()
public java.util.List<java.lang.String> lines()
public java.util.List<TdbHitPoint> hits()
public void clear()
public void scrollDown() throws TdbException
TdbException
public void scrollUp() throws TdbException
TdbException
public void scrollNext() throws TdbException
TdbException
public void scrollPrevious() throws TdbException
TdbException
public void close() throws TdbException
TdbException
public java.lang.String toFormattedString(java.lang.String before, java.lang.String after, java.lang.String linebreak) throws TdbException
before
- String to be inserted before hit termsafter
- String to be inserted after hit termslinebreak
- String to be inserted to delimit lines within the bufferTdbException
public java.lang.String toString()
toString
in class java.lang.Object