Class JDPBrowser

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----JDPClassLayout
                                   |
                                   +----JDPBrowser

public class JDPBrowser
extends JDPClassLayout
Class JDPBrowser represents a simple HTML browsing class.


Constructor Index

 o JDPBrowser()

Method Index

 o back()
Step back and load the previously loaded document.
 o forward()
Step forward and load the previously loaded document.
 o getDocname()
Get the name of the current html document.
 o getFontSize()
Get the default font size for the browser
 o getFullDocname()
Get the full path of the current html document.
 o getMatchCompleteWords()
Get the value of matchCompleteWords.
 o handleEvent(Event)
 o InitClass(JDPUser, Panel, String)
Creates a HTML browser.
 o layout()
 o minimumSize()
 o paint(Graphics)
 o preferredSize()
 o setDocname(String)
Set the name of the current html document.
 o setDocname(String, boolean)
Set the name of the current html document.
 o setFontSize(int)
Set the default font size for the browser
 o setFullDocname(String)
Set the full path of the current html document.
 o setKeywords(String[])
 o setMatchCompleteWords(boolean)
Set the new value of matchCompleteWords.
 o update(Graphics)

Constructors

 o JDPBrowser
 public JDPBrowser()

Methods

 o getDocname
 public String getDocname()
Get the name of the current html document.

Returns:
the name of the current html document.
 o getFullDocname
 public String getFullDocname()
Get the full path of the current html document.

Returns:
the full path of the current html document.
 o setFullDocname
 public boolean setFullDocname(String name)
Set the full path of the current html document.

Parameters:
docName - the name of the html document.
Returns:
true is the html document was found and loaded.
 o getMatchCompleteWords
 public boolean getMatchCompleteWords()
Get the value of matchCompleteWords.

Returns:
matchCompleteWords.
 o setDocname
 public boolean setDocname(String docName)
Set the name of the current html document. This will also load the requested document.

Parameters:
docName - the name of the html document.
Returns:
true is the html document was found and loaded.
 o setDocname
 public boolean setDocname(String docName,
                           boolean displayErrors)
Set the name of the current html document. This will also load the requested document.

Parameters:
docName - the name of the html document.
displayErrors - set true to display any error messages received while attempting to load the document.
Returns:
true is the html document was found and loaded.
 o setKeywords
 public void setKeywords(String keywords[])
 o setFontSize
 public void setFontSize(int size)
Set the default font size for the browser

Parameters:
size - the new default font size
 o getFontSize
 public int getFontSize()
Get the default font size for the browser

Returns:
the default font size
 o setMatchCompleteWords
 public void setMatchCompleteWords(boolean matchCompleteWords)
Set the new value of matchCompleteWords.

 o InitClass
 public void InitClass(JDPUser user,
                       Panel targetPanel,
                       String moduleParameter)
Creates a HTML browser.

Parameters:
user - JDPUser the global user parameter used to pass handles in JDP.
targetPanel - the parent panel that this one will be added to.
moduleParameter - a generic parameter used for specific internal functions.
Overrides:
InitClass in class JDPClassLayout
 o back
 public boolean back()
Step back and load the previously loaded document.

Returns:
true is the html document was found and loaded.
 o forward
 public boolean forward()
Step forward and load the previously loaded document. This is only valid if back() has been called prior.

Returns:
true is the html document was found and loaded.
 o handleEvent
 public synchronized boolean handleEvent(Event e)
Overrides:
handleEvent in class Component
 o layout
 public void layout()
Overrides:
layout in class Container
 o minimumSize
 public Dimension minimumSize()
Overrides:
minimumSize in class Container
 o paint
 public synchronized void paint(Graphics g)
Overrides:
paint in class Container
 o preferredSize
 public Dimension preferredSize()
Overrides:
preferredSize in class Container
 o update
 public synchronized void update(Graphics g)
Overrides:
update in class Component