com.adventnet.beans.utilbeans.help
Class ContextSensitiveHelpButton

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.AbstractButton
                          |
                          +--javax.swing.JButton
                                |
                                +--com.adventnet.beans.utilbeans.help.ContextSensitiveHelpButton

public final class ContextSensitiveHelpButton

extends javax.swing.JButton

implements java.awt.event.ActionListener, java.awt.event.MouseMotionListener, java.awt.event.MouseListener, javax.swing.event.ChangeListener

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JButton

javax.swing.JButton.AccessibleJButton

Inner classes inherited from class javax.swing.AbstractButton

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static java.net.URL

rootURL

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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

ContextSensitiveHelpButton()

ContextSensitiveHelpButton(java.util.ResourceBundle bundle)

ContextSensitiveHelpButton(java.lang.String helpIconPath, java.lang.String noHelpAvailableIconPath)
Creates a new ContextSensitiveHelpButton instance with the specified icons.

ContextSensitiveHelpButton(java.lang.String helpIconPath, java.lang.String noHelpAvailableIconPath, java.util.ResourceBundle bundle)

Method Summary

void	actionPerformed(java.awt.event.ActionEvent aEvtArg)
static ContextSensitiveHelpButton	getHelpButton(java.lang.String xmlFileArg, java.lang.String helpFileArg)
static ContextSensitiveHelpButton	getHelpButton(java.lang.String xmlFileArg, java.lang.String helpFileArg, java.util.ResourceBundle bundle)
static ContextSensitiveHelpButton	getHelpButton(java.lang.String xmlFileArg, java.lang.String helpFileArg, java.lang.String helpIconPath, java.lang.String noHelpAvailableIconPath)
static ContextSensitiveHelpButton	getHelpButton(java.lang.String xmlFileArg, java.lang.String helpFileArg, java.lang.String helpIconPath, java.lang.String noHelpAvailableIconPath, java.util.ResourceBundle bundle)
java.awt.Dimension	getHelpWindowSize() Returns the size of the context sensitive help window.
boolean	isFocusTraversable()
void	mouseClicked(java.awt.event.MouseEvent mEvtArg)
void	mouseDragged(java.awt.event.MouseEvent mEvtArg)
void	mouseEntered(java.awt.event.MouseEvent mEvtArg)
void	mouseExited(java.awt.event.MouseEvent mEvtArg)
void	mouseMoved(java.awt.event.MouseEvent mEvtArg)
void	mousePressed(java.awt.event.MouseEvent mEvtArg)
void	mouseReleased(java.awt.event.MouseEvent mEvtArg)
java.util.Map	parse(java.net.URL urlArg)
void	setHelpAvailableIcon(java.lang.String helpIcon) Sets the icon to be shown if help is available
void	setHelpWindowSize(java.awt.Dimension d) sets the size of the context sensitive help window.
void	setNoHelpAvailableIcon(java.lang.String noHelpIcon) Sets the icon to be shown if help is not available
void	setPrefixURL(java.net.URL prefixURLArg)
void	setXmlURL(java.net.URL contextHelpXmlArg)
void	showGlassPanel()
void	stateChanged(javax.swing.event.ChangeEvent e)

Methods inherited from class javax.swing.JButton

getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, setDefaultCapable, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getActionCommand, getDisabledIcon, getDisabledSelectedIcon, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getLabel, getMargin, getMnemonic, getModel, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, 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, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, 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, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, 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, hide, 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, 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, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Field Detail

rootURL

public static java.net.URL rootURL

Constructor Detail

ContextSensitiveHelpButton

public ContextSensitiveHelpButton()

ContextSensitiveHelpButton

public ContextSensitiveHelpButton(java.util.ResourceBundle bundle)

ContextSensitiveHelpButton

public ContextSensitiveHelpButton(java.lang.String helpIconPath,
                                  java.lang.String noHelpAvailableIconPath)

Creates a new ContextSensitiveHelpButton instance with the specified icons.

Parameters:

helpIconPath - a String value

noHelpIconPath - a String value

ContextSensitiveHelpButton

public ContextSensitiveHelpButton(java.lang.String helpIconPath,
                                  java.lang.String noHelpAvailableIconPath,
                                  java.util.ResourceBundle bundle)

Method Detail

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent e)

Specified by:

stateChanged in interface javax.swing.event.ChangeListener

isFocusTraversable

public boolean isFocusTraversable()

Overrides:

isFocusTraversable in class javax.swing.JComponent

setHelpAvailableIcon

public void setHelpAvailableIcon(java.lang.String helpIcon)

Sets the icon to be shown if help is available

Parameters:

helpIcon - a String value

setNoHelpAvailableIcon

public void setNoHelpAvailableIcon(java.lang.String noHelpIcon)

Sets the icon to be shown if help is not available

Parameters:

noHelpIcon - a String value

setHelpWindowSize

public void setHelpWindowSize(java.awt.Dimension d)

sets the size of the context sensitive help window. Default size is 450 x 200

Parameters:

d - a Dimension value

getHelpWindowSize

public java.awt.Dimension getHelpWindowSize()

Returns the size of the context sensitive help window.

Returns:

a Dimension value

setPrefixURL

public void setPrefixURL(java.net.URL prefixURLArg)

setXmlURL

public void setXmlURL(java.net.URL contextHelpXmlArg)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent aEvtArg)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

showGlassPanel

public void showGlassPanel()

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent mEvtArg)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent mEvtArg)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

parse

public java.util.Map parse(java.net.URL urlArg)
                    throws java.lang.Exception

getHelpButton

public static ContextSensitiveHelpButton getHelpButton(java.lang.String xmlFileArg,
                                                       java.lang.String helpFileArg)

getHelpButton

public static ContextSensitiveHelpButton getHelpButton(java.lang.String xmlFileArg,
                                                       java.lang.String helpFileArg,
                                                       java.util.ResourceBundle bundle)

getHelpButton

public static ContextSensitiveHelpButton getHelpButton(java.lang.String xmlFileArg,
                                                       java.lang.String helpFileArg,
                                                       java.lang.String helpIconPath,
                                                       java.lang.String noHelpAvailableIconPath)

getHelpButton

public static ContextSensitiveHelpButton getHelpButton(java.lang.String xmlFileArg,
                                                       java.lang.String helpFileArg,
                                                       java.lang.String helpIconPath,
                                                       java.lang.String noHelpAvailableIconPath,
                                                       java.util.ResourceBundle bundle)

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent mEvtArg)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent mEvtArg)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent mEvtArg)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent mEvtArg)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent mEvtArg)

Specified by:

mousePressed in interface java.awt.event.MouseListener