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

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

Direct Known Subclasses:

VttObj

public class VttGui
extends java.lang.Object

This class defines global variables used in Visual Tagging Tool.

History:

• SCR-94, chlu, 02-03-10, new VTT file format to include Meta-Data

Version:

V-2010

Author:

NLM NLS Development Team, clu

Constructor Summary

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

Method Summary

AddTagDialog	GetAddTagDialog() Get tag add dialog.
ConfigOptionsDialog	GetConfigOptionsDialog() Get configuration option dialog.
EditTagDialog	GetEditTagDialog() Get tag eidt dialog.
FindDialog	GetFindDialog() Get find dialog.
DocHtmlBrowser	GetHelpDoc() Get Vtt help document.
int	GetHighlightEnd() Set end position of highlight.
int	GetHighlightStart() Get start position of highlight.
MainFrame	GetMainFrame() Get Vtt main frame.
MarkupDialog	GetMarkupDialog() Get markup dialog.
MarkupsDialog	GetMarkupsDialog() Get markups dialog.
MetaDataDialog	GetMetaDataDialog() Get Meta data option dialog.
boolean	GetOverlap() Get the mode of overlap
TagsDialog	GetTagsDialog() Get tags dialog.
UndoManager	GetUndoManager() Get Vtt undo manager.
VttPopupMenu	GetVttPopupMenu() Get Vtt popup menu.
ZoomDialog	GetZoomDialog() Get zoom dialog.
protected void	InitGui(VttObj vttObj, MainFrame mainFrame) Init GUI components
void	SetHelpDoc(DocHtmlBrowser helpDoc) Set Vtt help document.
void	SetHighlightEnd(int highlightEnd) Set the end position of highlight.
void	SetHighlightStart(int highlightStart) Set the start position of highlight.
void	SetMainFrame(MainFrame mainFrame) Set Vtt main frame.
void	SetOverlap(boolean overlap) Set the Vtt overlap mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

VttGui

public VttGui()

Create a VttGui Java object with default values.

Method Detail

GetMainFrame

public MainFrame GetMainFrame()

Get Vtt main frame.

Returns:

Vtt main frame

GetVttPopupMenu

public VttPopupMenu GetVttPopupMenu()

Get Vtt popup menu.

Returns:

Vtt popup menu

GetHelpDoc

public DocHtmlBrowser GetHelpDoc()

Get Vtt help document.

Returns:

Vtt help document

GetMarkupDialog

public MarkupDialog GetMarkupDialog()

Get markup dialog.

Returns:

markup dialog

GetMarkupsDialog

public MarkupsDialog GetMarkupsDialog()

Get markups dialog.

Returns:

markups dialog

GetTagsDialog

public TagsDialog GetTagsDialog()

Get tags dialog.

Returns:

tags dialog

GetEditTagDialog

public EditTagDialog GetEditTagDialog()

Get tag eidt dialog.

Returns:

tag eidt dialog

GetAddTagDialog

public AddTagDialog GetAddTagDialog()

Get tag add dialog.

Returns:

tag add dialog

GetFindDialog

public FindDialog GetFindDialog()

Get find dialog.

Returns:

find dialog

GetZoomDialog

public ZoomDialog GetZoomDialog()

Get zoom dialog.

Returns:

zoom dialog

GetConfigOptionsDialog

public ConfigOptionsDialog GetConfigOptionsDialog()

Get configuration option dialog.

Returns:

configuration option dialog

GetMetaDataDialog

public MetaDataDialog GetMetaDataDialog()

Get Meta data option dialog.

Returns:

Meta data option dialog

SetMainFrame

public void SetMainFrame(MainFrame mainFrame)

Set Vtt main frame.

Parameters:

mainFrame - Vtt main frame

SetHelpDoc

public void SetHelpDoc(DocHtmlBrowser helpDoc)

Set Vtt help document.

Parameters:

helpDoc - Vtt help document

GetHighlightStart

public int GetHighlightStart()

Get start position of highlight.

Returns:

start position of highlight

GetHighlightEnd

public int GetHighlightEnd()

Set end position of highlight.

Returns:

end position of highlight

GetOverlap

public boolean GetOverlap()

Get the mode of overlap

Returns:

a boolean flag of overlap mode

GetUndoManager

public UndoManager GetUndoManager()

Get Vtt undo manager.

Returns:

Vtt undo manager

SetHighlightStart

public void SetHighlightStart(int highlightStart)

Set the start position of highlight.

Parameters:

highlightStart - the start position of highlight

SetHighlightEnd

public void SetHighlightEnd(int highlightEnd)

Set the end position of highlight.

Parameters:

highlightEnd - the end position of highlight

SetOverlap

public void SetOverlap(boolean overlap)

Set the Vtt overlap mode.

Parameters:

overlap - the Vtt overlap mode

InitGui

protected void InitGui(VttObj vttObj,
                       MainFrame mainFrame)

Init GUI components

Parameters:

vttObj - the Vtt object

mainFrame - Vtt main frame