writer2latex.api

Class 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

IndexPageEntry(String sFile, boolean bIsDirectory)
Construct a new IndexPageEntry based on a file name.

Method Summary

String
getDescription()
Get the description
String
getDisplayName()
Get the display name
String
getFile()
Get the file name
String
getOriginalFile()
Get the original file name
String
getPdfFile()
Get the pdf file name
boolean
isDirectory()
Check whether this is a file or a directory
void
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
setFile(String sFile)
Set the file name
void
setOriginalFile(String sOriginalFile)
Set the file name for the original file
void
setPdfFile(String sPdfFile)
Set the file name for a pdf file associated with this file

Constructor Details

IndexPageEntry

public IndexPageEntry(String sFile,
                      boolean bIsDirectory)
Construct a new IndexPageEntry based on a file name. The file name is also used as display name.
Parameters:
sFile - the file name for this entry
bIsDirectory - true if this is a directory, false if it is a file

Method Details

getDescription

public String getDescription()
Get the description
Returns:
the description, or null if there is no description

getDisplayName

public String getDisplayName()
Get the display name
Returns:
the display name

getFile

public String getFile()
Get the file name
Returns:
the file name

getOriginalFile

public String getOriginalFile()
Get the original file name
Returns:
the file name or null if there is none

getPdfFile

public String getPdfFile()
Get the pdf 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

setDescription

public void setDescription(String sDescription)
Set the description of this file (additional information about the file)
Parameters:
sDescription - the description

setDisplayName

public void setDisplayName(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

setFile

public void setFile(String sFile)
Set the file name
Parameters:
sFile - the file name

setOriginalFile

public void setOriginalFile(String sOriginalFile)
Set the file name for the original file
Parameters:
sOriginalFile - the origianl file name

setPdfFile

public void setPdfFile(String sPdfFile)
Set the file name for a pdf file associated with this file
Parameters:
sPdfFile - the file name