com.sssw.rt.tview
Class TView

java.lang.Object
 |
 +--java.awt.Component
       |
       +--java.awt.Container
             |
             +--javax.swing.JComponent
                   |
                   +--javax.swing.JPanel
                         |
                         +--com.sssw.rt.atlas.AtPanel
                               |
                               +--com.sssw.rt.tview.TView

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

AgcView

public class TView

extends com.sssw.rt.atlas.AtPanel

The SilverStream base class for SilverStream's Java-based view controls.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Inner classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Fields inherited from class com.sssw.rt.atlas.AtPanel

BGIMAGE_DRAW_CENTERED, BGIMAGE_DRAW_NORMAL, BGIMAGE_DRAW_STRETCH, BGIMAGE_DRAW_TILED

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

TView()

Method Summary

AgoViewFormat	getAgoViewFormat() Obtains the AgoViewFormat object associated with the view.
boolean	getSearchable() Returns true if the first AgoColumnText column appended to the view has been specified to be searchable.
void	reload() Recreates the view's rows of data beginning with the top row.
void	scrollHome() Scrolls the view display to the top
void	setAgoViewFormat(AgoViewFormat viewformat) Refreshes the AgoViewFormat object.
void	setSearchable(boolean enableSearch) Specifies that the first AgoColumnText column appended to the view supports type-ahead search.

Methods inherited from class com.sssw.rt.atlas.AtPanel

addImpl, addNotify, clientPaint, clientPaint, deliverMouseEvent, deliverMouseMoveEvent, doAtCommand, drawTiledImage, enableAtCommands, getBackgroundImage, getBackgroundImageMode, getHelper, getTransparent, hide, hideToolTip, imageUpdate, isFocusTraversable, isOptimizedDrawingEnabled, ownedImage, paintBorder, paintComponent, paintImmediately, paintImmediately, paintNow, preprocessKeyEvent, processEvent, reshape, setBackgroundImage, setBackgroundImageMode, setTransparent, show, showToolTip

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, paramString, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isManagingFocus, isOpaque, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, print, printAll, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TView

public TView()

Method Detail

scrollHome

public void scrollHome()

Scrolls the view display to the top

reload

public void reload()

Recreates the view's rows of data beginning with the top row.

Usage:

Use reload() after calling refreshRows() to redisplay the new data to users, or after making any other kind of change to the data where you were not actually changing it through the view.

Can also be used in place of setAgoViewFormat() to refresh the view's physical appearance. For example, if you programmatically change the background color of a column or a font style.

See Also:

TView.setAgoViewFormat(AgoViewFormat viewformat)

getAgoViewFormat

public AgoViewFormat getAgoViewFormat()

Obtains the AgoViewFormat object associated with the view.

See Also:

TView.setAgoViewFormat(AgoViewFormat viewformat)

setAgoViewFormat

public void setAgoViewFormat(AgoViewFormat viewformat)

Refreshes the AgoViewFormat object. This allows any programmatic changes to the view to be displayed to users.

Parameters:

viewformat - - specifies the AgoViewFormat to refresh

Usage:

Programmatic changes can include adding or removing columns and changing color or font styles. Use reload() when you need to refresh the data as well as the format.

See Also:

TView.reload(), TView.getAgoViewFormat()

setSearchable

public void setSearchable(boolean enableSearch)

Specifies that the first AgoColumnText column appended to the view supports type-ahead search.

Parameters:

enableSearch - when true, the first AgoColumnText appended to the view supports type-ahead search.

Usage:

When true and a user selects a column and begins typing, the view scrolls automatically to the first entry that matches what has typed.

If the user pauses for a second or more, the view resets the search and will start with what the user has typed after pausing. No error is generated when the view does not contain an AgoColumnText column.

See Also:

TView.getSearchable()

getSearchable

public boolean getSearchable()

Returns true if the first AgoColumnText column appended to the view has been specified to be searchable.

Usage:

Can return true even if there is no text column but setSearchable() has been called.

See Also:

TView.setSearchable(boolean enableSearch)