org.jpedal.examples.viewer

Class RecentDocuments

java.lang.Object

org.jpedal.examples.viewer.RecentDocuments

All Implemented Interfaces:

RecentDocumentsFactory

public class RecentDocuments
extends Object
implements RecentDocumentsFactory

Field Summary

Fields

Modifier and Type	Field and Description
int	noOfRecentDocs
JMenuItem[]	recentDocuments

Constructor Summary

Constructors

Constructor and Description
RecentDocuments(int noOfRecentDocs)

Method Summary

Modifier and Type	Method and Description
void	addToFileList(String selectedFile) Adds a file to the list of recent file
void	clearRecentDocuments(PropertiesFile properties) Remove all items from the recent documents list and stored in properties list
void	createMenuItems(String fileNameToAdd, int position, GUIFactory currentGUI, Values commonValues) Create the menu items used to represent the recent documents in the Viewer menu
void	enableRecentDocuments(boolean enable) Control if recent documents items should be enabled and visible
String	getNextDocument() Get the file name of the next document in the list.
String	getPreviousDocument() Get the previously opened documents file name
void	updateRecentDocuments(String[] recentDocs) Set the recent documents items from the set of values provided

Methods inherited from class java.lang.Object

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

Field Detail

noOfRecentDocs

public final int noOfRecentDocs

recentDocuments

public final JMenuItem[] recentDocuments

Constructor Detail

RecentDocuments

public RecentDocuments(int noOfRecentDocs)

Method Detail

getPreviousDocument

public String getPreviousDocument()

Get the previously opened documents file name

Specified by:

getPreviousDocument in interface RecentDocumentsFactory

Returns:

String value representing the documents file name

getNextDocument

public String getNextDocument()

Get the file name of the next document in the list. This can be used to move through the list of recent files *

Specified by:

getNextDocument in interface RecentDocumentsFactory

Returns:

String value representing the documents file name

addToFileList

public void addToFileList(String selectedFile)

Adds a file to the list of recent file

Specified by:

addToFileList in interface RecentDocumentsFactory

Parameters:

selectedFile - String representing a file name

enableRecentDocuments

public void enableRecentDocuments(boolean enable)

Control if recent documents items should be enabled and visible

Specified by:

enableRecentDocuments in interface RecentDocumentsFactory

Parameters:

enable - True to show and enable the recent documents items, false otherwise

updateRecentDocuments

public void updateRecentDocuments(String[] recentDocs)

Set the recent documents items from the set of values provided

Specified by:

updateRecentDocuments in interface RecentDocumentsFactory

Parameters:

recentDocs - String array of file names to load into the recent documents

clearRecentDocuments

public void clearRecentDocuments(PropertiesFile properties)

Remove all items from the recent documents list and stored in properties list

Specified by:

clearRecentDocuments in interface RecentDocumentsFactory

Parameters:

properties - PropertiesFile object holding the recent documents to clear

createMenuItems

public void createMenuItems(String fileNameToAdd,
                            int position,
                            GUIFactory currentGUI,
                            Values commonValues)

Create the menu items used to represent the recent documents in the Viewer menu

Specified by:

createMenuItems in interface RecentDocumentsFactory

Parameters:

fileNameToAdd - String filename for the menu item

position - int value representing the position in the recent documents

currentGUI - GUIFactory object to add the menu item to

commonValues - Values object used by the view