oracle.dss.util.gui.layout
Class Layout

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.util.gui.layout.Layout

All Implemented Interfaces:

javax.accessibility.Accessible, DataDirectorListener, java.util.EventListener, HelpContext, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

Direct Known Subclasses:

CrosstabLayout, GraphLayout, TableLayout

public class Layout

extends javax.swing.JPanel

implements DataDirectorListener, HelpContext

A Layout panel. 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 int	HIDDEN_EDGE The hidden edge.
static java.lang.String	PAGEEDGEVISIBLE_CHANGED Property name to listen for when a user chooses to show or hide the paging control.

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

Layout()
Constructor.

Method Summary

void	addLayoutPivotingListener(LayoutPivotingListener l) Registers a listener for pivot changes.
boolean	apply() Apples to the query the changes that the user makes in 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.
LayoutAccess	getLayoutAccess() Retrieves the LayoutAccess for this Layout.
LayoutContext	getLayoutContext() Retrieves the LayoutContext for this Layout.
boolean	isHelpEnabled() Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
boolean	isHideAvailable() Indicates whether the option for hiding the paging control appears in the keyboard popup menus.
boolean	isPagingControlVisible() Indicates whether the control that displays page items appears in this Layout.
void	removeLayoutPivotingListener(LayoutPivotingListener l) Removes a pivoting listener.
void	setDescriptionText(java.lang.String description) Specifies the text that is displayed at the top of this panel.
void	setErrorHandler(ErrorHandler eh) Specifies the error handler for this Layout panel.
void	setHelpContextID(java.lang.String strHelpContextID) Sets the Help context ID for this panel.
void	setHelpEnabled(boolean bValue) Specifies whether a Help button in a dialog box that is displayed by this panel, is displayed.
void	setHideAvailable(boolean hideAvailable) Specifies whether the option for hiding the paging control is available in the keyboard popup menus.
void	setLayoutAccess(LayoutAccess layoutAccess) Specifies the LayoutAccess for this Layout.
void	setLayoutContext(LayoutContext lc) Specifies the LayoutContext for this Layout.
void	setLocale(java.util.Locale loc) Specifies the current Locale that this panel uses.
void	setPagingControlVisible(boolean isVisible) Specifies whether the control that displays page items should be visible.
void	viewDataAvailable(DataAvailableEvent e) Responds to changes in the availability of data.
void	viewDataChanged(DataChangedEvent e) Responds to changes to the data or metadata.
void	waitDataAvailable(WaitDataAvailableEvent e) Responds to a completed data fetch.

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

HIDDEN_EDGE

public static final int HIDDEN_EDGE

The hidden edge.

PAGEEDGEVISIBLE_CHANGED

public static final java.lang.String PAGEEDGEVISIBLE_CHANGED

Property name to listen for when a user chooses to show or hide the paging control.

Constructor Detail

Layout

public Layout()

Constructor.

Method Detail

getDescriptionText

public java.lang.String getDescriptionText()

Retrieves the text that is displayed at the top of this panel.

Returns:

The text that describes this Layout.

setDescriptionText

public void setDescriptionText(java.lang.String description)

Specifies the text that is displayed at the top of this panel.

Parameters:

The - text that describes this Layout.

setPagingControlVisible

public void setPagingControlVisible(boolean isVisible)

Specifies whether the control that displays page items should be visible.

Parameters:

isVisible - true to display the paging control, false to hide it.

isPagingControlVisible

public boolean isPagingControlVisible()

Indicates whether the control that displays page items appears in this Layout.

Returns:

true if the paging control is visible, false if it is not.

setHideAvailable

public void setHideAvailable(boolean hideAvailable)

Specifies whether the option for hiding the paging control is available in the keyboard popup menus.

Parameters:

hideAvailable - true to display the Hide option in the popup menus, false to remove it from the popup menus.

isHideAvailable

public boolean isHideAvailable()

Indicates whether the option for hiding the paging control appears in the keyboard popup menus.

Returns:

true if the hide option appears in the keyboard popup menus, false if it does not appear in the popup menus.

setLayoutContext

public void setLayoutContext(LayoutContext lc)

Specifies the LayoutContext for this Layout.

getLayoutContext

public LayoutContext getLayoutContext()

Retrieves the LayoutContext for this Layout.

setLayoutAccess

public void setLayoutAccess(LayoutAccess layoutAccess)

Specifies the LayoutAccess for this Layout. 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.

Parameters:

layoutAccess - An implementation of the LayoutAccess interface.

See Also:

apply()

getLayoutAccess

public LayoutAccess getLayoutAccess()

Retrieves the LayoutAccess for this Layout.

Returns:

The implementation of the LayoutAccess interface that this panel uses.

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.

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

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Specifies the error handler for this Layout panel.

Parameters:

eh - The error handler to use.

setLocale

public void setLocale(java.util.Locale loc)

Specifies the current Locale that this panel uses.

Overrides:

setLocale in class java.awt.Component

Parameters:

loc - The current Locale.

addLayoutPivotingListener

public void addLayoutPivotingListener(LayoutPivotingListener l)

Registers a listener for pivot changes. This Layout fires a LayoutPivotingEvent to all registered listeners before the pivot is executed on the DataDirector implementation of the LayoutAccess.

Parameters:

l - The listener to add.

See Also:

LayoutPivotingEvent, DataDirector

removeLayoutPivotingListener

public void removeLayoutPivotingListener(LayoutPivotingListener l)

Removes a pivoting listener.

Parameters:

l - The listener to remove.

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.

Specified by:

getHelpContextID in interface HelpContext

Returns:

The Help context ID for this panel.

setHelpContextID

public void setHelpContextID(java.lang.String strHelpContextID)

Sets the Help context ID for this panel.

Specified by:

setHelpContextID in interface HelpContext

Following copied from interface: oracle.dss.util.help.HelpContext

Parameters:

strHelpContextID - a String value that represents the Help context ID.

setHelpEnabled

public void setHelpEnabled(boolean bValue)

Specifies whether a Help button in a dialog box that is displayed by this panel, is displayed.

For example, suppose that this panel had a font button and that font button displayed a font dialog box. If that font dialog box had a Help button, then this method would specify whether that Help button is displayed.

Parameters:

bValue - true to display the Help button, false to hide it.

isHelpEnabled

public boolean isHelpEnabled()

Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.

For example, suppose that this panel had a font button and that font button displayed a font dialog box. If that font dialog box had a Help button, then this method would tell you whether that Help button is displayed.

Returns:

true if the Help button is hidden, false if it is displayed.

viewDataChanged

public void viewDataChanged(DataChangedEvent e)

Responds to changes to the data or metadata. This method responds by setting its internal DataAcess to that in the DataChangedEvent. Application developers should not call this method.

Specified by:

viewDataChanged in interface DataDirectorListener

Parameters:

e - Information about the data change.

viewDataAvailable

public void viewDataAvailable(DataAvailableEvent e)

Responds to changes in the availability of data. This method responds by setting its internal DataAcess to that in the DataChangedEvent. Application developers should not call this method.

Specified by:

viewDataAvailable in interface DataDirectorListener

Parameters:

e - Information about the availability of data.

waitDataAvailable

public void waitDataAvailable(WaitDataAvailableEvent e)

Responds to a completed data fetch. Application developers should not call this method.

Specified by:

waitDataAvailable in interface DataDirectorListener

Parameters:

e - Information about the fetch.