Package writer2latex.api
Class IndexPageEntry
- java.lang.Object
-
- writer2latex.api.IndexPageEntry
-
public class IndexPageEntry extends java.lang.Object
This class represents a single entry on an index page created by a batch converter
-
-
Constructor Summary
Constructors Constructor Description IndexPageEntry(java.lang.String sFile, boolean bIsDirectory)
Construct a newIndexPageEntry
based on a file name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Get the descriptionjava.lang.String
getDisplayName()
Get the display namejava.lang.String
getFile()
Get the file namejava.lang.String
getOriginalFile()
Get the original file namejava.lang.String
getPdfFile()
Get the pdf file nameboolean
isDirectory()
Check whether this is a file or a directoryvoid
setDescription(java.lang.String sDescription)
Set the description of this file (additional information about the file)void
setDisplayName(java.lang.String sDisplayName)
Set the display name for this entry.void
setFile(java.lang.String sFile)
Set the file namevoid
setOriginalFile(java.lang.String sOriginalFile)
Set the file name for the original filevoid
setPdfFile(java.lang.String sPdfFile)
Set the file name for a pdf file associated with this file
-
-
-
Constructor Detail
-
IndexPageEntry
public IndexPageEntry(java.lang.String sFile, boolean bIsDirectory)
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 Detail
-
setFile
public void setFile(java.lang.String sFile)
Set the file name- Parameters:
sFile
- the file name
-
setDisplayName
public void setDisplayName(java.lang.String sDisplayName)
Set the display name for this entry. The display name is the name presented on the index page.- Parameters:
sDisplayName
- the display name
-
setDescription
public void setDescription(java.lang.String sDescription)
Set the description of this file (additional information about the file)- Parameters:
sDescription
- the description
-
setPdfFile
public void setPdfFile(java.lang.String sPdfFile)
Set the file name for a pdf file associated with this file- Parameters:
sPdfFile
- the file name
-
setOriginalFile
public void setOriginalFile(java.lang.String sOriginalFile)
Set the file name for the original file- Parameters:
sOriginalFile
- the origianl file name
-
getFile
public java.lang.String getFile()
Get the file name- Returns:
- the file name
-
getDisplayName
public java.lang.String getDisplayName()
Get the display name- Returns:
- the display name
-
getDescription
public java.lang.String getDescription()
Get the description- Returns:
- the description, or null if there is no description
-
getPdfFile
public java.lang.String getPdfFile()
Get the pdf file name- Returns:
- the file name or null if there is none
-
getOriginalFile
public java.lang.String 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
-
-