Package writer2latex.api
Class IndexPageEntry
java.lang.Object
writer2latex.api.IndexPageEntry
This class represents a single entry on an index page created by a batch converter
-
Constructor Summary
ConstructorsConstructorDescriptionIndexPageEntry
(String sFile, boolean bIsDirectory) Construct a newIndexPageEntry
based on a file name. -
Method Summary
Modifier and TypeMethodDescriptionGet the descriptionGet the display namegetFile()
Get the file nameGet the original file nameGet the pdf file nameboolean
Check whether this is a file or a directoryvoid
setDescription
(String sDescription) Set the description of this file (additional information about the file)void
setDisplayName
(String sDisplayName) Set the display name for this entry.void
Set the file namevoid
setOriginalFile
(String sOriginalFile) Set the file name for the original filevoid
setPdfFile
(String sPdfFile) Set the file name for a pdf file associated with this file
-
Constructor Details
-
IndexPageEntry
Construct a newIndexPageEntry
based on a file name. The file name is also used as display name.- Parameters:
sFile
- the file name for this entrybIsDirectory
- true if this is a directory, false if it is a file
-
-
Method Details
-
setFile
Set the file name- Parameters:
sFile
- the file name
-
setDisplayName
Set the display name for this entry. The display name is the name presented on the index page.- Parameters:
sDisplayName
- the display name
-
setDescription
Set the description of this file (additional information about the file)- Parameters:
sDescription
- the description
-
setPdfFile
Set the file name for a pdf file associated with this file- Parameters:
sPdfFile
- the file name
-
setOriginalFile
Set the file name for the original file- Parameters:
sOriginalFile
- the origianl file name
-
getFile
Get the file name- Returns:
- the file name
-
getDisplayName
Get the display name- Returns:
- the display name
-
getDescription
Get the description- Returns:
- the description, or null if there is no description
-
getPdfFile
Get the pdf file name- Returns:
- the file name or null if there is none
-
getOriginalFile
Get the original file name- Returns:
- the file name or null if there is none
-
isDirectory
public boolean isDirectory()Check whether this is a file or a directory- Returns:
- true for a directory, false for a file
-