Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.util.gui.layout
Class TableLayout

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.util.gui.layout.Layout
                                |
                                +--oracle.dss.util.gui.layout.TableLayout
All Implemented Interfaces:
javax.accessibility.Accessible, DataDirectorListener, java.util.EventListener, HelpContext, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class TableLayout
extends Layout

The Layout panel for the Table bean. Layout panels work with a LayoutContext and a LayoutAccess to allow a user to change the layout of a query.

See Also:
LayoutContext, LayoutAccess, Serialized Form

Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent

 

Field Summary
static java.lang.String HIDE_DUPLICATE_ROWS
          Property name to listen for when a user chooses to show or hide the option that controls duplicate rows.

 

Fields inherited from class oracle.dss.util.gui.layout.Layout
HIDDEN_EDGE, PAGEEDGEVISIBLE_CHANGED

 

Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, 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

 

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

 

Constructor Summary
TableLayout()
          Constuctor.

 

Method Summary
 boolean apply()
          Apples to the query the changes that the user makes in this panel.
 void cleanup(boolean finished)
          Cleans up this panel.
 java.lang.String getDescriptionText()
          Retrieves the text that is displayed at the top of this panel.
 java.lang.String getHelpContextID()
          Retrieves the Help context ID for this panel.
 java.awt.Component getInitialFocus()
          Retrieves the component that has focus when this TableLayout is initially displayed.
 boolean isDuplicateRowsControlVisible()
          Indicates whether the control for hiding duplicate rows appears in this TableLayout.
 void setDuplicateRowsControlVisible(boolean isVisible)
          Specifies whether the checkbox control for the duplicate table rows appears in this TableLayout.
 void setLayoutAccess(LayoutAccess layoutAccess)
          Specifies the LayoutAccess for this TableLayout.
 void setLayoutContext(LayoutContext lc)
          Specifies the LayoutContext for this Layout.
 void setPagingControlAttributes(PagingControlAttributes pca)
          Specifies PagingControlAttributes implementation so that this panel can set the properties of the PagingControl.

 

Methods inherited from class oracle.dss.util.gui.layout.Layout
addLayoutPivotingListener, getLayoutAccess, getLayoutContext, isHelpEnabled, isHideAvailable, isPagingControlVisible, removeLayoutPivotingListener, setDescriptionText, setErrorHandler, setHelpContextID, setHelpEnabled, setHideAvailable, setLocale, setPagingControlVisible, viewDataAvailable, viewDataChanged, waitDataAvailable

 

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, updateUI

 

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, 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, remove, remove, removeAll, removeContainerListener, setLayout, validate

 

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

HIDE_DUPLICATE_ROWS

public static final java.lang.String HIDE_DUPLICATE_ROWS
Property name to listen for when a user chooses to show or hide the option that controls duplicate rows.
Constructor Detail

TableLayout

public TableLayout()
Constuctor.
Method Detail

setPagingControlAttributes

public void setPagingControlAttributes(PagingControlAttributes pca)
Specifies PagingControlAttributes implementation so that this panel can set the properties of the PagingControl.

apply

public boolean apply()
Apples to the query the changes that the user makes in this panel. This method applies the LayoutAccess to the original query.
Overrides:
apply in class Layout
Returns:
true if the changes were successfully applied, false if the LayoutAccess is null or if the changes could not be applied.
See Also:
LayoutAccess

getDescriptionText

public java.lang.String getDescriptionText()
Retrieves the text that is displayed at the top of this panel.
Overrides:
getDescriptionText in class Layout
Returns:
The text that describes this TableLayout.

setDuplicateRowsControlVisible

public void setDuplicateRowsControlVisible(boolean isVisible)
Specifies whether the checkbox control for the duplicate table rows appears in this TableLayout. If you pass true to this method, then you must support the display or hiding of duplicate rows in the table.
Parameters:
isVisible - true to display the duplicate rows control in this TableLayout, false to remove the control.

isDuplicateRowsControlVisible

public boolean isDuplicateRowsControlVisible()
Indicates whether the control for hiding duplicate rows appears in this TableLayout.
Returns:
true if the duplicate rows control appears in this TableLayout, false if it does not.

setLayoutAccess

public void setLayoutAccess(LayoutAccess layoutAccess)
Specifies the LayoutAccess for this TableLayout. This panel uses the LayoutAccess to store the changes that the user makes to the layout of the data. The changes in the LayoutAccess do not affect the original query until the apply method is called.
Overrides:
setLayoutAccess in class Layout
Parameters:
layoutAccess - An implementation of the LayoutAccess interface.
See Also:
apply()

setLayoutContext

public void setLayoutContext(LayoutContext lc)
Specifies the LayoutContext for this Layout.
Overrides:
setLayoutContext in class Layout

getInitialFocus

public java.awt.Component getInitialFocus()
Retrieves the component that has focus when this TableLayout is initially displayed.
Returns:
The component that has the initial focus.

cleanup

public void cleanup(boolean finished)
Cleans up this panel.
Parameters:
finished - true if this panel is not part of a wizard or if the wizard has finished executing and the class can release all of its resources, false if the user has simply moved to a different page in a wizard.

getHelpContextID

public java.lang.String getHelpContextID()
Retrieves the Help context ID for this panel. The Help context ID is the full class path for this panel. This Help context ID is used when listening for the user event to display Help for this panel.
Overrides:
getHelpContextID in class Layout
Returns:
The Help context ID for this panel.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.