org.tentackle.appworx
Class TooltipAndErrorPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.tentackle.ui.FormPanel
                      org.tentackle.appworx.TooltipAndErrorPanel

All Implemented Interfaces:

ContainerListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, FormContainer, TooltipDisplay

public class TooltipAndErrorPanel
extends FormPanel
implements TooltipDisplay

Provides a tooltip-like info field and an error-list the user can click on set the focus to the related component.

Author:

harald

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, 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

TooltipAndErrorPanel()
Creates the panel.

Method Summary

boolean	areValuesChanged() Checks whether the contents of some components in this or sub containers have changed since the last savepoint.
void	clearErrors() Clears all errors and removes the errorpane.
List<InteractiveError>	getErrors() Gets the current errors as a List of InteractiveErrors
String	getTooltip() Gets the displayed tooltip.
int	getVisibleErrorCount() Gets the maximum number of visible rows in error list.
boolean	isTooltipEnabled() Returns whether the tooltip display is enabled.
void	setErrors(InteractiveError... error) Sets the errors. Alternative to setErrors(java.util.List) saves typing if number of errors is known.
void	setErrors(List<InteractiveError> errors) Sets the list of errors.
void	setTooltip(String tooltip) Sets the text for the tooltip.
void	setTooltipEnabled(boolean enable) Enables/disables the tooltip-field.
void	setVisibleErrorCount(int rows) Sets the maximum number of visible rows in the error list. If more errors are present a scrollbar will be shown.

Methods inherited from class org.tentackle.ui.FormPanel

addActionListener, componentAdded, componentRemoved, fireActionPerformed, getFormValues, getHelpURL, getParentWindow, getTitle, invalidateParentInfo, isAllChangeable, isHonourAllChangeable, removeActionListener, saveValues, setAllChangeable, setFormValues, setFormValuesKeepChanged, setHelpURL, setHonourAllChangeable, setTitle, showHelp, triggerValuesChanged

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

TooltipAndErrorPanel

public TooltipAndErrorPanel()

Creates the panel.

Method Detail

areValuesChanged

public boolean areValuesChanged()

Description copied from interface: FormContainer

Checks whether the contents of some components in this or sub containers have changed since the last savepoint.

Specified by:

areValuesChanged in interface FormContainer

Overrides:

areValuesChanged in class FormPanel

Returns:

true if changed

setTooltipEnabled

public void setTooltipEnabled(boolean enable)

Enables/disables the tooltip-field.

Parameters:

enable - true to enable the tooltip display, default is false.

isTooltipEnabled

public boolean isTooltipEnabled()

Returns whether the tooltip display is enabled.

Returns:

true if the tooltip-field is visible

setVisibleErrorCount

public void setVisibleErrorCount(int rows)

Sets the maximum number of visible rows in the error list.
If more errors are present a scrollbar will be shown. The default is 4.

Parameters:

rows - the number of rows

getVisibleErrorCount

public int getVisibleErrorCount()

Gets the maximum number of visible rows in error list.

Returns:

the number of rows.

setTooltip

public void setTooltip(String tooltip)

Description copied from interface: TooltipDisplay

Sets the text for the tooltip.

Specified by:

setTooltip in interface TooltipDisplay

Parameters:

tooltip - the tooltip text

getTooltip

public String getTooltip()

Gets the displayed tooltip.

Returns:

the tooltip, null if none

clearErrors

public void clearErrors()

Clears all errors and removes the errorpane.

getErrors

public List<InteractiveError> getErrors()

Gets the current errors as a List of InteractiveErrors

Returns:

the list of errors, null if none

setErrors

public void setErrors(List<InteractiveError> errors)

Sets the list of errors.

Parameters:

errors - the list of InteractiveErrors, null = clears all errors

setErrors

public void setErrors(InteractiveError... error)

Sets the errors.
Alternative to setErrors(java.util.List) saves typing if number of errors is known.

 Example:
  setErrors(new InteractiveError("blah not set", blahField),
            new InteractiveError("foo must be less than blah", fooField));
 

Parameters:

error - the error(s) to set