org.rosuda.JGR
Class JGRHelp

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.rosuda.JGR.toolkit.iFrame
                          org.rosuda.JGR.JGRHelp

All Implemented Interfaces:

ActionListener, KeyListener, MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class JGRHelp
extends iFrame
implements ActionListener, KeyListener, MouseListener

JGRHelp - an implemenation of a simple htmlbrowser combined with r-help search engine.

Author:

Markus Helbig RoSuDa 2003 - 2005

See Also:

Serialized Form

Nested Class Summary

class

JGRHelp.HelpArea

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static JGRHelp	current Current JGRHelp, because we only want to open one helpbrowser.
JLabel	link Current link located with the mouse cursor
static String	RHELPLOCATION Path to html help of R

Fields inherited from class org.rosuda.JGR.toolkit.iFrame

clsAbout, clsEditor, clsHelp, clsJavaGD, clsMain, clsObjBrowser, clsPackageUtil, clsPlot, clsPrefs, clsSplash, clsTable, clsUser, MYEntry

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

JGRHelp()

JGRHelp(String location)
Create a new JGRHelp - browser with specified help-location.

Method Summary

void	actionPerformed(ActionEvent e) actionPerformed: handle action event: menus.
void	keyPressed(KeyEvent ke) keyPressed: handle key event.
void	keyReleased(KeyEvent ke) keyReleased: handle key event: transfer selected commands to console.
void	keyTyped(KeyEvent ke) keyTyped: handle key event.
void	mouseClicked(MouseEvent e) mouseClicked: handle mouse event: close tab.
void	mouseEntered(MouseEvent e) mouseEntered: handle mouse event.
void	mouseExited(MouseEvent e) mouseExited: handle mouse event.
void	mousePressed(MouseEvent e) mousePressed: handle mouse event.
void	mouseReleased(MouseEvent e) mouseReleased: handle mouse event.
void	print() Print current help-page.
void	search() Search for the keyword written in the search-field.
void	search(String keyword) Search for the keyword.
void	search(String keyword, boolean exact) Search for the keyword, you can choosed it it should match exactly or not

Methods inherited from class org.rosuda.JGR.toolkit.iFrame

cursorDefault, cursorWait, finalize, getMYEntry, initPlacement, setMinimumSize, setWorking, show

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

current

public static JGRHelp current

Current JGRHelp, because we only want to open one helpbrowser.

link

public JLabel link

Current link located with the mouse cursor

RHELPLOCATION

public static String RHELPLOCATION

Path to html help of R

Constructor Detail

JGRHelp

public JGRHelp()

JGRHelp

public JGRHelp(String location)

Create a new JGRHelp - browser with specified help-location.

Parameters:

location - path pointing to html-help

Method Detail

print

public void print()

Print current help-page.

search

public void search()

Search for the keyword written in the search-field.

search

public void search(String keyword,
                   boolean exact)

Search for the keyword, you can choosed it it should match exactly or not

Parameters:

keyword - keyword

exact - match exactly or not

search

public void search(String keyword)

Search for the keyword.

Parameters:

keyword - keyword

actionPerformed

public void actionPerformed(ActionEvent e)

actionPerformed: handle action event: menus.

Specified by:

actionPerformed in interface ActionListener

keyTyped

public void keyTyped(KeyEvent ke)

keyTyped: handle key event.

Specified by:

keyTyped in interface KeyListener

keyPressed

public void keyPressed(KeyEvent ke)

keyPressed: handle key event.

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent ke)

keyReleased: handle key event: transfer selected commands to console.

Specified by:

keyReleased in interface KeyListener

mouseClicked

public void mouseClicked(MouseEvent e)

mouseClicked: handle mouse event: close tab.

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

mouseEntered: handle mouse event.

Specified by:

mouseEntered in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

mousePressed: handle mouse event.

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

mouseReleased: handle mouse event.

Specified by:

mouseReleased in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

mouseExited: handle mouse event.

Specified by:

mouseExited in interface MouseListener