pkgMcj.Folder Class Reference

Collaboration diagram for pkgMcj.Folder:

[legend]List of all members.

---

Detailed Description

Definition at line 21 of file Folder.java.

Public Member Functions
	Folder (Mcj parent, String pathName)
boolean	loadNames ()
int	getNumEntries ()
String	getFolderName ()
String	getParentName ()
String	getCurrentName (int numSamples)
	gets one file name from the array of files
String	getNextName (int numSamples)
long	getLongDate (String fname)
String	getStringDate (String fname)
boolean	isDirectoryName (String fname)
String	stringToPath (String fname)
String	getLength (String fname, boolean skip)
int	getAnchor ()
void	setAnchor (int startIndex)
void	saveAnchor ()
void	restoreAnchor ()

---

Constructor & Destructor Documentation

pkgMcj.Folder.Folder (  Mcj  parent, String  pathName )

construct a folder for some directory Definition at line 41 of file Folder.java.

---

Member Function Documentation

boolean pkgMcj.Folder.loadNames (   )

loads current folder/directory into a File array Definition at line 71 of file Folder.java. References pkgMcj.Mcj.errorMsg(), pkgMcj.Mcj.goodbye(), pkgMcj.Mcj.logFile, and pkgUtil.FileOut.putString(). Referenced by pkgMcj.PanelGrid.loadPage(), and pkgMcj.Mcj.testFolder().

int pkgMcj.Folder.getNumEntries (   )

gets numEntries Returns: numEntries .. Definition at line 130 of file Folder.java. Referenced by pkgMcj.Mcj.testFolder().

String pkgMcj.Folder.getFolderName (   )

gets folder name. Returns: name string of current folder/directory Definition at line 140 of file Folder.java. Referenced by pkgMcj.Mcj.testFolder().

String pkgMcj.Folder.getParentName (   )

gets parent name. Returns: name string of current folder/directory parent Definition at line 150 of file Folder.java.

String pkgMcj.Folder.getCurrentName (  int  numSamples  )

Parameters: numSamples  the file array index Returns: the file name string or null Definition at line 159 of file Folder.java.

String pkgMcj.Folder.getNextName (  int  numSamples  )

gets one file name from the array of files Parameters: numSamples  the file array index Returns: the file name string or null Definition at line 181 of file Folder.java. Referenced by pkgMcj.Mcj.testFolder().

long pkgMcj.Folder.getLongDate (  String  fname  )

gets date of the named file as a long integer Parameters: fname  .. the file name Returns: the date in milliseconds Definition at line 202 of file Folder.java. References pkgMcj.Mcj.errorMsg().

String pkgMcj.Folder.getStringDate (  String  fname  )

gets date of the named file Parameters: fname  .. the file name Returns: the formatted filename string Definition at line 220 of file Folder.java. References pkgMcj.Mcj.errorMsg().

boolean pkgMcj.Folder.isDirectoryName (  String  fname  )

Parameters: fname  .. name of a file in the current folder Returns: File .. the file object Definition at line 234 of file Folder.java.

String pkgMcj.Folder.stringToPath (  String  fname  )

Parameters: fname  .. name of a file in the current folder Returns: File .. the file absolute pathname as string Definition at line 247 of file Folder.java.

String pkgMcj.Folder.getLength (  String  fname, boolean  skip )

gets byte count of file as a formatted string. Parameters: fname  .. the file name skip  .. skip formatting if true Returns: the formatted filesize string Definition at line 261 of file Folder.java. Referenced by pkgMcj.Mcj.testFolder().

int pkgMcj.Folder.getAnchor (   )

gets anchor which is current position in array of files Returns: anchor .. the current position Definition at line 288 of file Folder.java.

void pkgMcj.Folder.setAnchor (  int  startIndex  )

sets index to one file in the list. Parameters: startIndex  .. the anchor or index into the list Definition at line 297 of file Folder.java.

void pkgMcj.Folder.saveAnchor (   )

saves current anchor which can later be restored Definition at line 312 of file Folder.java.

void pkgMcj.Folder.restoreAnchor (   )

restores current anchor which was previously saved Definition at line 320 of file Folder.java.

---

The documentation for this class was generated from the following file:

• src/pkgMcj/Folder.java

---