A B C D E F G H I J L M N O P Q R S T U V

A

actionPerformed(ActionEvent) - Method in class net.sourceforge.helpgui.gui.MainFrame

Handles buttons events

add(Page) - Method in class net.sourceforge.helpgui.page.PageList

Add a new page on the list.

add(Page) - Method in class net.sourceforge.helpgui.page.PageRoot

Adds a page to this project (in the root of the project).

addBookMark(JMenuItem, Page) - Method in class net.sourceforge.helpgui.page.PageBookMarks

Insert a new bookmark

addBookMarks() - Method in class net.sourceforge.helpgui.gui.MainFrame

Set a bookmark to the current page

addPage(Page, boolean) - Method in class net.sourceforge.helpgui.page.LinkedPage

Insert a new page on the list

addSubPage(Page) - Method in class net.sourceforge.helpgui.page.Page

Adds a sub page to this page.

B

BareBonesBrowserLaunch - Class in com.centerkey.utils

BareBonesBrowserLaunch() - Constructor for class com.centerkey.utils.BareBonesBrowserLaunch

BrowserControl - Class in net.sourceforge.helpgui.util

A simple, static class to display an URL in the system browser.

BrowserControl() - Constructor for class net.sourceforge.helpgui.util.BrowserControl

C

children() - Method in class net.sourceforge.helpgui.page.Page

Returns the children of the receiver as an Enumeration.

children() - Method in class net.sourceforge.helpgui.page.PageRoot

Returns the children of the receiver as an Enumeration.

clear() - Method in class net.sourceforge.helpgui.page.PageList

Removes all the pages from this list.

com.centerkey.utils - package com.centerkey.utils

D

debug - Static variable in class net.sourceforge.helpgui.HelpGui

For debug test

displayURL(String) - Static method in class net.sourceforge.helpgui.util.BrowserControl

Display an URL in the system browser.

E

equals(Page) - Method in class net.sourceforge.helpgui.page.Page

Return true is the page is the same.

F

FAILED - Static variable in class net.sourceforge.helpgui.util.Out

firstNodeExpand() - Method in class net.sourceforge.helpgui.gui.HelpView

Expand the first node of the Tree

G

get(int) - Method in class net.sourceforge.helpgui.page.PageList

Return a page by its index.

getAllowsChildren() - Method in class net.sourceforge.helpgui.page.Page

Returns true if the receiver allows children.

getAllowsChildren() - Method in class net.sourceforge.helpgui.page.PageRoot

Returns true if the receiver allows children.

getBookMark(JMenuItem) - Method in class net.sourceforge.helpgui.page.PageBookMarks

Get a bookmarks

getChildAt(int) - Method in class net.sourceforge.helpgui.page.Page

Returns the child TreeNode at index childIndex.

getChildAt(int) - Method in class net.sourceforge.helpgui.page.PageRoot

Returns the child TreeNode at index childIndex.

getChildCount() - Method in class net.sourceforge.helpgui.page.Page

Returns the number of children TreeNodes the receiver contains.

getChildCount() - Method in class net.sourceforge.helpgui.page.PageRoot

Returns the number of children TreeNodes the receiver contains.

getCurrentPage() - Method in class net.sourceforge.helpgui.gui.HelpView

Return the current page

getCurrentPage() - Method in class net.sourceforge.helpgui.page.LinkedPage

Return the current page

getFirstChild() - Method in class net.sourceforge.helpgui.page.PageRoot

getHome() - Method in class net.sourceforge.helpgui.page.Page

Convert the Page into String.

getImage() - Method in class net.sourceforge.helpgui.page.Page

Return the icon name for this page.

getIndex(TreeNode) - Method in class net.sourceforge.helpgui.page.Page

Returns the index of node in the receivers children.

getIndex(Page) - Method in class net.sourceforge.helpgui.page.PageList

Returns the index of the specified task.

getIndex(TreeNode) - Method in class net.sourceforge.helpgui.page.PageRoot

Returns the index of node in the receivers children.

getInstance() - Static method in class net.sourceforge.helpgui.page.PageBookMarks

getInstance() - Static method in class net.sourceforge.helpgui.util.Language

Get the instance of the language

getJTree() - Method in class net.sourceforge.helpgui.gui.HelpView

Get the JTree of the panel

getKey() - Method in class net.sourceforge.helpgui.page.Page

Returns the key associated with this page, or null if none exists

getNextPage() - Method in class net.sourceforge.helpgui.page.LinkedPage

Get the next page

getParent() - Method in class net.sourceforge.helpgui.page.Page

Returns the parent TreeNode of the receiver.

getParent() - Method in class net.sourceforge.helpgui.page.PageRoot

Returns the parent TreeNode of the receiver.

getPath() - Method in class net.sourceforge.helpgui.page.Page

Return the path of the Page on the Tree

getPreviousPage() - Method in class net.sourceforge.helpgui.page.LinkedPage

Get the previous page

getTarget() - Method in class net.sourceforge.helpgui.page.Page

Return the target of the page (the HTML URI).

getText() - Method in class net.sourceforge.helpgui.page.Page

Return the Title of the Page.

getText(String) - Method in class net.sourceforge.helpgui.util.Language

getTextArea() - Method in class net.sourceforge.helpgui.gui.HelpView

Get the TextArea of the panel

getTreeCellRendererComponent(JTree, Object, boolean, boolean, boolean, int, boolean) - Method in class net.sourceforge.helpgui.gui.TreeRenderer

goHome() - Method in class net.sourceforge.helpgui.gui.HelpView

Go to the home page

gotoTopic(String) - Method in class net.sourceforge.helpgui.gui.HelpView

Goes to a help topic based on the passed key, or ignores the request if the key is not found

gotoTopic(String) - Method in class net.sourceforge.helpgui.gui.MainFrame

Goes to a help topic based on the passed key, or ignores the request if the key is not found

H

hasMoreElements() - Method in class net.sourceforge.helpgui.page.PageEnumeration

Tests if this enumeration contains more elements.

HelpGui - Class in net.sourceforge.helpgui

A class for Lauch the Help Viewer

HelpGui() - Constructor for class net.sourceforge.helpgui.HelpGui

helpPath - Static variable in class net.sourceforge.helpgui.gui.MainFrame

The help path where the data are

helpPathType - Static variable in class net.sourceforge.helpgui.gui.MainFrame

The type of path specified

HelpView - Class in net.sourceforge.helpgui.gui

View for the project, contain the tree on the left and the text on the right

HelpView() - Constructor for class net.sourceforge.helpgui.gui.HelpView

Constructor.

helpView - Variable in class net.sourceforge.helpgui.gui.MainFrame

home - Variable in class net.sourceforge.helpgui.page.Page

If this page is home

hyperlinkUpdate(HyperlinkEvent) - Method in class net.sourceforge.helpgui.gui.HelpView

Action when a link is pressed (for HTML listener)

I

iconsPath - Static variable in class net.sourceforge.helpgui.gui.MainFrame

The icons path where the icons are

indexOf(Page) - Method in class net.sourceforge.helpgui.page.PageList

Returns the index of the specified page.

initFrame(String, String) - Method in class net.sourceforge.helpgui.gui.MainFrame

Standard Constructor.

insert(MutableTreeNode, int) - Method in class net.sourceforge.helpgui.page.Page

Adds child to the receiver at index.

insert(MutableTreeNode, int) - Method in class net.sourceforge.helpgui.page.PageRoot

Adds child to the receiver at index.

isEmpty() - Method in class net.sourceforge.helpgui.page.PageList

Tells if the list is empty or not.

isInList(Page) - Method in class net.sourceforge.helpgui.page.PageList

Tells if a page is or not in this list.

isLeaf() - Method in class net.sourceforge.helpgui.page.Page

Returns true if the receiver is a leaf.

isLeaf() - Method in class net.sourceforge.helpgui.page.PageRoot

Returns true if the receiver is a leaf.

isOpaque() - Method in class net.sourceforge.helpgui.gui.TestRolloverButton

iterator - Variable in class net.sourceforge.helpgui.page.PageEnumeration

An iterator on the list

iterator() - Method in class net.sourceforge.helpgui.page.PageList

Returns a list iterator on this list.

J

jbBookmarks - Variable in class net.sourceforge.helpgui.gui.MainFrame

jbHome - Variable in class net.sourceforge.helpgui.gui.MainFrame

jbNext - Variable in class net.sourceforge.helpgui.gui.MainFrame

jbPrev - Variable in class net.sourceforge.helpgui.gui.MainFrame

Buttons on the toolbar

jbPrint - Variable in class net.sourceforge.helpgui.gui.MainFrame

L

Language - Class in net.sourceforge.helpgui.util

Class that help to get text from differents file format

length - Static variable in class net.sourceforge.helpgui.util.Out

LinkedPage - Class in net.sourceforge.helpgui.page

List of page viewed by the user

LinkedPage() - Constructor for class net.sourceforge.helpgui.page.LinkedPage

load() - Method in class net.sourceforge.helpgui.parser.TocOpen

Load the toc.xml file and create the tree

M

main(String[]) - Static method in class net.sourceforge.helpgui.HelpGui

MainFrame - Class in net.sourceforge.helpgui.gui

Main frame of the help GUI

MainFrame() - Constructor for class net.sourceforge.helpgui.gui.MainFrame

Standard Constructor.

MainFrame(String) - Constructor for class net.sourceforge.helpgui.gui.MainFrame

Standard Constructor.

MainFrame(String, String) - Constructor for class net.sourceforge.helpgui.gui.MainFrame

Standard Constructor.

MainFrame(String, int, String) - Constructor for class net.sourceforge.helpgui.gui.MainFrame

Standard Constructor.

MainFrame(String, int) - Constructor for class net.sourceforge.helpgui.gui.MainFrame

Standard Constructor.

mouseClicked(MouseEvent) - Method in class net.sourceforge.helpgui.gui.HelpView

Invoked when the mouse button has been clicked (pressed and released) on a component.

mouseEntered(MouseEvent) - Method in class net.sourceforge.helpgui.gui.HelpView

Invoked when the mouse enters a component.

mouseExited(MouseEvent) - Method in class net.sourceforge.helpgui.gui.HelpView

Invoked when the mouse exits a component.

mousePressed(MouseEvent) - Method in class net.sourceforge.helpgui.gui.HelpView

Invoked when a mouse button has been pressed on a component.

mouseReleased(MouseEvent) - Method in class net.sourceforge.helpgui.gui.HelpView

Invoked when a mouse button has been released on a component.

msg(String) - Static method in class net.sourceforge.helpgui.util.Out

Write a message on the standar output and finish it by [ OK ].

msg(String, int) - Static method in class net.sourceforge.helpgui.util.Out

Write a message on the standar output and finish it by the specify state (OK, or FAILED).

N

net.sourceforge.helpgui - package net.sourceforge.helpgui

net.sourceforge.helpgui.gui - package net.sourceforge.helpgui.gui

net.sourceforge.helpgui.page - package net.sourceforge.helpgui.page

net.sourceforge.helpgui.parser - package net.sourceforge.helpgui.parser

net.sourceforge.helpgui.util - package net.sourceforge.helpgui.util

nextElement() - Method in class net.sourceforge.helpgui.page.PageEnumeration

Returns the next element of this enumeration if this enumeration object has at least one more element to provide.

nextPage() - Method in class net.sourceforge.helpgui.gui.HelpView

Set the next page

O

OK - Static variable in class net.sourceforge.helpgui.util.Out

openURL(String) - Static method in class com.centerkey.utils.BareBonesBrowserLaunch

Out - Class in net.sourceforge.helpgui.util

Class aible to write a simple message on the console

Out() - Constructor for class net.sourceforge.helpgui.util.Out

P

Page - Class in net.sourceforge.helpgui.page

Class where the date are showed

Page(String, String, String, boolean, Page) - Constructor for class net.sourceforge.helpgui.page.Page

Constructor

Page(String, String, String, boolean, PageRoot) - Constructor for class net.sourceforge.helpgui.page.Page

Constructor

Page(String, String, String, String, boolean, Page) - Constructor for class net.sourceforge.helpgui.page.Page

Constructor

Page(String, String, String, String, boolean, PageRoot) - Constructor for class net.sourceforge.helpgui.page.Page

Constructor

PageBookMarks - Class in net.sourceforge.helpgui.page

BookMarks Manager

PageBookMarks() - Constructor for class net.sourceforge.helpgui.page.PageBookMarks

Constructor

PageEnumeration - Class in net.sourceforge.helpgui.page

Enumeration of the pages

PageEnumeration(PageList) - Constructor for class net.sourceforge.helpgui.page.PageEnumeration

Standard constructor.

PageList - Class in net.sourceforge.helpgui.page

List of page for the help topic

PageList() - Constructor for class net.sourceforge.helpgui.page.PageList

Constructor.

PageRoot - Class in net.sourceforge.helpgui.page

Root node for the tree

PageRoot() - Constructor for class net.sourceforge.helpgui.page.PageRoot

Constructor.

pages - Variable in class net.sourceforge.helpgui.page.Page

subpages list

pages - Variable in class net.sourceforge.helpgui.page.PageRoot

paint(Graphics) - Method in class net.sourceforge.helpgui.gui.TestRolloverButton

paintComponent(Graphics) - Method in class net.sourceforge.helpgui.gui.TextArea

Override for the paintComponent of a JTextPane to enable antialiased rendering of the help page.

parentNode - Variable in class net.sourceforge.helpgui.page.PageRoot

parentPage - Variable in class net.sourceforge.helpgui.page.Page

Page this page is a child of

PATH_TYPE_FILESYSTEM - Static variable in class net.sourceforge.helpgui.gui.MainFrame

Specifies the help path as a true file path

PATH_TYPE_RESOURCE - Static variable in class net.sourceforge.helpgui.gui.MainFrame

Specifies the help path as a "resource"

previousPage() - Method in class net.sourceforge.helpgui.gui.HelpView

Set the previous page

print() - Method in class net.sourceforge.helpgui.gui.HelpView

Print the page

print(Graphics, PageFormat, int) - Method in class net.sourceforge.helpgui.gui.TextArea

Print the current page

Q

quit() - Method in class net.sourceforge.helpgui.gui.MainFrame

Close the Frame

R

remove(int) - Method in class net.sourceforge.helpgui.page.Page

Removes the child at index from the receiver.

remove(MutableTreeNode) - Method in class net.sourceforge.helpgui.page.Page

Removes node from the receiver.

remove(int) - Method in class net.sourceforge.helpgui.page.PageList

Removes the specified page form the list.

remove(Page) - Method in class net.sourceforge.helpgui.page.PageList

Removes the specified page form the list.

remove(int) - Method in class net.sourceforge.helpgui.page.PageRoot

Removes the child at index from the receiver.

remove(MutableTreeNode) - Method in class net.sourceforge.helpgui.page.PageRoot

Removes node from the receiver.

removeFromParent() - Method in class net.sourceforge.helpgui.page.Page

Removes the receiver from its parent.

removeFromParent() - Method in class net.sourceforge.helpgui.page.PageRoot

Removes the receiver from its parent.

rootPage - Variable in class net.sourceforge.helpgui.page.Page

project this page belong to

S

setEnabled(boolean) - Method in class net.sourceforge.helpgui.gui.TestRolloverButton

setLocale(Locale) - Method in class net.sourceforge.helpgui.util.Language

Set the local value

setParent(MutableTreeNode) - Method in class net.sourceforge.helpgui.page.Page

Sets the parent of the receiver to newParent.

setParent(MutableTreeNode) - Method in class net.sourceforge.helpgui.page.PageRoot

Sets the parent of the receiver to newParent.

setUserObject(Object) - Method in class net.sourceforge.helpgui.page.Page

Resets the user object of the receiver to object.

setUserObject(Object) - Method in class net.sourceforge.helpgui.page.PageRoot

Resets the user object of the receiver to object.

size() - Method in class net.sourceforge.helpgui.page.PageList

Returns the number of pages in this list.

T

TestRolloverButton - Class in net.sourceforge.helpgui.gui

Special button for tests on TaskPropertiesBeans

TestRolloverButton() - Constructor for class net.sourceforge.helpgui.gui.TestRolloverButton

Setup the border (invisible initially)

TestRolloverButton(Icon) - Constructor for class net.sourceforge.helpgui.gui.TestRolloverButton

Setup the border (invisible initially)

TextArea - Class in net.sourceforge.helpgui.gui

Class where the date are showed

TextArea() - Constructor for class net.sourceforge.helpgui.gui.TextArea

Constructor

TocOpen - Class in net.sourceforge.helpgui.parser

Aible to to load a toc and construct the tree

TocOpen(HelpView) - Constructor for class net.sourceforge.helpgui.parser.TocOpen

Constructor

toString() - Method in class net.sourceforge.helpgui.page.LinkedPage

Return the string correcponding to the LinkedPage class

toString() - Method in class net.sourceforge.helpgui.page.Page

Convert the Page into String.

toString() - Method in class net.sourceforge.helpgui.page.PageList

Returns a string that describes current instance content.

toString() - Method in class net.sourceforge.helpgui.page.PageRoot

Convert the Page into String.

TreeRenderer - Class in net.sourceforge.helpgui.gui

Tree rendering

TreeRenderer() - Constructor for class net.sourceforge.helpgui.gui.TreeRenderer

U

update(Page, String) - Method in class net.sourceforge.helpgui.gui.TextArea

Fonction call when a new page has to be show

updatePage(Page, String, boolean) - Method in class net.sourceforge.helpgui.gui.HelpView

Set a new page on the browser and and it on the list of the last page view

updateTreeSelection(MouseEvent) - Method in class net.sourceforge.helpgui.gui.HelpView

Updates tree selection on a mouse event.

userObject - Variable in class net.sourceforge.helpgui.page.Page

User object

userObject - Variable in class net.sourceforge.helpgui.page.PageRoot

V

version - Variable in class net.sourceforge.helpgui.gui.MainFrame

Version of HelpGUI.

A B C D E F G H I J L M N O P Q R S T U V