gov.nih.nlm.nls.vtt.Model
Class VttObj

java.lang.Object
  gov.nih.nlm.nls.vtt.Model.VttGui
      gov.nih.nlm.nls.vtt.Model.VttObj

public class VttObj
extends VttGui

This class defines Visual Tagging Tool API.

History:

• SCR-92, clu, 01-27-10, add YEAR_STR for VTT year release

Version:

V-2010

Author:

NLM NLS Development Team, clu

Constructor Summary

VttObj()
Create a VttObj Java object with default values.

VttObj(java.io.File inFile)
Create a VttObj Java object by specifying input file.

VttObj(java.io.File inFile, int x, int y)
Create a VttObj Java object by specifying input file and initial position of Vtt.

VttObj(java.io.File inFile, java.lang.String configFile, int x, int y)
Create a VttObj Java object by specifying input file, configuration file, and initial position of Vtt.

VttObj(int x, int y)
Create a VttObj Java object by specifying initial position of Vtt.

Method Summary

ConfigObj	GetConfigObj() Get Vtt configuration object.
java.io.File	GetDocFile() Get Vtt document file.
java.lang.String	GetVersionInfo() Get Vtt version information.
VttDocument	GetVttDocument() Get Vtt document.
void	SetDocFile(java.io.File docFile) Set Vtt document file.

Methods inherited from class gov.nih.nlm.nls.vtt.Model.VttGui

GetAddTagDialog, GetConfigOptionsDialog, GetEditTagDialog, GetFindDialog, GetHelpDoc, GetHighlightEnd, GetHighlightStart, GetMainFrame, GetMarkupDialog, GetMarkupsDialog, GetMetaDataDialog, GetOverlap, GetTagsDialog, GetUndoManager, GetVttPopupMenu, GetZoomDialog, InitGui, SetHelpDoc, SetHighlightEnd, SetHighlightStart, SetMainFrame, SetOverlap

Methods inherited from class java.lang.Object

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

Constructor Detail

VttObj

public VttObj()

Create a VttObj Java object with default values.

VttObj

public VttObj(java.io.File inFile)

Create a VttObj Java object by specifying input file.

Parameters:

inFile - input file

VttObj

public VttObj(int x,
              int y)

Create a VttObj Java object by specifying initial position of Vtt.

Parameters:

x - x position

y - y position

VttObj

public VttObj(java.io.File inFile,
              int x,
              int y)

Create a VttObj Java object by specifying input file and initial position of Vtt.

Parameters:

inFile - input file

x - x position

y - y position

VttObj

public VttObj(java.io.File inFile,
              java.lang.String configFile,
              int x,
              int y)

Create a VttObj Java object by specifying input file, configuration file, and initial position of Vtt.

Parameters:

inFile - input file

configFile - configuration file

x - x position

y - y position

Method Detail

GetVersionInfo

public java.lang.String GetVersionInfo()

Get Vtt version information.

Returns:

Vtt version information

GetConfigObj

public ConfigObj GetConfigObj()

Get Vtt configuration object.

Returns:

Vtt configuration object

GetDocFile

public java.io.File GetDocFile()

Get Vtt document file.

Returns:

Vtt document file

GetVttDocument

public VttDocument GetVttDocument()

Get Vtt document.

Returns:

Vtt document

SetDocFile

public void SetDocFile(java.io.File docFile)

Set Vtt document file.

Parameters:

docFile - Vtt document file