com.retek.commons.gui.widget
Class RPanel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bycom.retek.commons.gui.widget.RPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, REventListener, java.io.Serializable
Direct Known Subclasses:
MailOrderSummaryScreen.PaymentTable, RDateField, RDisplayCheckBox, REntryRow, REntryTable, ReturnLineNormalReturnPanel, ReturnLinePackReturnPanel, RHeaderRow, RLayerRow, RLayerTable, RScreen, RStatusBar, RTab, RTabPane, RTitleBar, RView, WorkListTable

public class RPanel
extends javax.swing.JPanel
implements REventListener

This class sublcasses the standard JPanel class in the Swing package to provide custom functionality for the Rcom client application.

Retek Inc. Copyright (c) 2002

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
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
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
RPanel()
          Returns new RPanel object.
 
Method Summary
 void addREventListener(REventListener listener)
          Adds a REventListener to the REventListener list.
 java.awt.Component[] getFocusCycleComponents()
          Retrieves an array of components sorted in the order of focus cycle .This method will ignore any components assigned by setFocusCycleComponents() that do not belong to this panel at the moment t his method is called.
 void notifyREventListeners(RActionEvent event)
          Notifies all listeners of an action event.
 void notifyREventListeners(RErrorEvent event)
          Notifies all listeners of an error event.
 void performActionEvent(RActionEvent event)
          Implements the required REventListener method.
 void performErrorEvent(RErrorEvent event)
          Implements the required REventListener method.
 void removeAllREventListeners()
          Removes a REventListener from the REventListener list.
 void removeREventListener(REventListener listener)
          Removes a REventListener from the REventListener list.
 void repaintPanel()
          Repaints the panel immediately after validating all widgets and layouts.
 void setEmptyBorder(int size)
          Places an empty border around the panel.
 void setEmptyBorder(int top, int left, int bottom, int right)
          Places an empty border aroundthe panel.
 void setFocusCycleComponents(java.awt.Component[] array)
          Assigns the cycle of focus within this component.
 void setLineBorder(int size)
          Builds a panel with a lined border and equal width border pad on each side of the panel.
 void setLineBorder(int top, int left, int bottom, int right)
          Builds a panel with a lined border and border padding specified by parameters.
 void setLoweredBevelBorder()
          Sets a lowered bevel border on the panel.
 void setMinimumHeight(int height)
          Sets the minimum height of the panel in pixels.
 void setRaisedBevelBorder()
          Sets a raised bevel border on the panel.
 void setTitleBorder(java.lang.String title)
          Builds a panel with a titled border and default border padding, zero on top where the label is and five pixels on all other sides.
 void setTitleBorder(java.lang.String title, int size)
          Builds a panel with a titled border and border padding specified by parameters.
 void setTitleBorder(java.lang.String title, int fontStyle, float fontSize)
          Builds a panel with a titled border and default border padding, zero on top where the label is and five pixels on all other sides.
 void setTitleBorder(java.lang.String title, int top, int left, int bottom, int right)
          Builds a panel with a titled border and border padding specified by parameters.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RPanel

public RPanel()
Returns new RPanel object.

Method Detail

setMinimumHeight

public void setMinimumHeight(int height)
Sets the minimum height of the panel in pixels.

Parameters:
height - The minimum height of the panel in pixels.

setEmptyBorder

public void setEmptyBorder(int size)
Places an empty border around the panel.

Parameters:
size - The size of the empty border (used on each side of the panel) in pixels.

setEmptyBorder

public void setEmptyBorder(int top,
                           int left,
                           int bottom,
                           int right)
Places an empty border aroundthe panel.

Parameters:
top - The top border in pixels.
left - The left border in pixels.
bottom - The bottom border in pixels.
right - The right border in pixels.

setLineBorder

public void setLineBorder(int size)
Builds a panel with a lined border and equal width border pad on each side of the panel.

Parameters:
size - The size of the border pad (between text and border) in pixels.

setLineBorder

public void setLineBorder(int top,
                          int left,
                          int bottom,
                          int right)
Builds a panel with a lined border and border padding specified by parameters.

Parameters:
top - The top border in pixels.
left - The left border in pixels.
bottom - The bottom border in pixels.
right - The right border in pixels.

setTitleBorder

public void setTitleBorder(java.lang.String title)
Builds a panel with a titled border and default border padding, zero on top where the label is and five pixels on all other sides. THIS SHOULD REFACTOR TO USE THE DEFAULT MARGINS IN THE THEME RESOURCES FILE.

Parameters:
title - The title to assign to the panel.

setTitleBorder

public void setTitleBorder(java.lang.String title,
                           int fontStyle,
                           float fontSize)
Builds a panel with a titled border and default border padding, zero on top where the label is and five pixels on all other sides. THIS SHOULD REFACTOR TO USE THE DEFAULT MARGINS IN THE THEME RESOURCES FILE.

Parameters:
title - The title to assign to the panel.
fontStyle - The font style to assign to the title.
fontSize - The font size to assign to the title.

setTitleBorder

public void setTitleBorder(java.lang.String title,
                           int size)
Builds a panel with a titled border and border padding specified by parameters.

Parameters:
title - The title to assign to the panel.
size - The size of the border pad (between text and border) in pixels.

setTitleBorder

public void setTitleBorder(java.lang.String title,
                           int top,
                           int left,
                           int bottom,
                           int right)
Builds a panel with a titled border and border padding specified by parameters.

Parameters:
title - The title to assign to the panel.
top - The top border in pixels.
left - The left border in pixels.
bottom - The bottom border in pixels.
right - The right border in pixels.

getFocusCycleComponents

public java.awt.Component[] getFocusCycleComponents()
Retrieves an array of components sorted in the order of focus cycle .This method will ignore any components assigned by setFocusCycleComponents() that do not belong to this panel at the moment t his method is called.

Returns:
An array of components sorted in the order of focus cycle.

setFocusCycleComponents

public void setFocusCycleComponents(java.awt.Component[] array)
Assigns the cycle of focus within this component.

Parameters:
array - An array of components sorted in the order of focus cycle.

setRaisedBevelBorder

public void setRaisedBevelBorder()
Sets a raised bevel border on the panel.


setLoweredBevelBorder

public void setLoweredBevelBorder()
Sets a lowered bevel border on the panel.


addREventListener

public void addREventListener(REventListener listener)
Adds a REventListener to the REventListener list.

Parameters:
listener - The REventListener to add.

removeREventListener

public void removeREventListener(REventListener listener)
Removes a REventListener from the REventListener list.

Parameters:
listener - The REventListener to remove.

removeAllREventListeners

public void removeAllREventListeners()
Removes a REventListener from the REventListener list.


notifyREventListeners

public void notifyREventListeners(RActionEvent event)
Notifies all listeners of an action event.

Parameters:
event - An RActionEvent object containing details about the event.

notifyREventListeners

public void notifyREventListeners(RErrorEvent event)
Notifies all listeners of an error event.

Parameters:
event - An RErrorEvent object containing details about the event.

performActionEvent

public void performActionEvent(RActionEvent event)
Implements the required REventListener method. It sends the event to all current REventListeners of the panel.

Specified by:
performActionEvent in interface REventListener
Parameters:
event - The RActionEvent that triggered this listener method.

performErrorEvent

public void performErrorEvent(RErrorEvent event)
Implements the required REventListener method. It sends the event to all current REventListeners of the panel.

Specified by:
performErrorEvent in interface REventListener
Parameters:
event - The RErrorEvent that triggered this listener method.

repaintPanel

public void repaintPanel()
Repaints the panel immediately after validating all widgets and layouts.



Copyright © 2004 Retek Inc. All Rights Reserved. - Generated at Fri, 10/22/2004 07:28