gov.nih.nlm.nls.vtt.Operations
Class MarkupOperations

java.lang.Object
  gov.nih.nlm.nls.vtt.Operations.MarkupOperations

public class MarkupOperations
extends java.lang.Object

This class provides text markup related operations.

History:

Version:

V-2010

Author:

NLM NLS Development Team, clu

Method Summary

static void	BackwardSelectMarkup(boolean showAll, VttObj vttObj) Move the select markup in backward direction.
static boolean	ChangeSelectMarkupOperation(Markup cur, VttObj vttObj) Change the selected (indexed) markup with a specified markup.
static void	ClearOperation(VttObj vttObj) This method clears the markup by using "Text/Clear" tag.
static void	DeleteAllOperation(javax.swing.JFrame owner, VttObj vttObj) Delete all markups operation
static void	DeleteOperation(VttObj vttObj) Delete the selected markup from Markups
static void	ForwardSelectMarkup(boolean showAll, VttObj vttObj) Move the select markup in forward direction.
static void	JoinOperation(VttObj vttObj) Join selected markup with the next markup to a new markup
static void	ResetSelectMarkup(VttObj vttObj) Reset the selected markup.
static void	SetEndSelectMarkup(boolean showAll, VttObj vttObj) Set the select index to the end of displayable markups (end).
static void	SetHomeSelectMarkup(boolean showAll, VttObj vttObj) Set the select markup to the beginning of displayable markups (home).
static void	SetSelectMarkup(int curPos, VttObj vttObj) Set selected Markup by left mouse click (current position of caret)
static void	UpdateModelessDialog(VttObj vttObj) Update Modeless dialog, Markup and Markups dialogs
static void	UpdateOperation(java.lang.String tagName, java.lang.String tagCategory, VttObj vttObj) Update a selected markup operation by specifying a tag (name and category) includes.

Methods inherited from class java.lang.Object

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

Method Detail

DeleteOperation

public static void DeleteOperation(VttObj vttObj)

Delete the selected markup from Markups

Parameters:

vttObj - the vttObj Java object

JoinOperation

public static void JoinOperation(VttObj vttObj)

Join selected markup with the next markup to a new markup

Parameters:

vttObj - the vttObj Java object

DeleteAllOperation

public static void DeleteAllOperation(javax.swing.JFrame owner,
                                      VttObj vttObj)

Delete all markups operation

Parameters:

owner - the owner of this dialog

vttObj - the vttObj Java object

UpdateOperation

public static void UpdateOperation(java.lang.String tagName,
                                   java.lang.String tagCategory,
                                   VttObj vttObj)

Update a selected markup operation by specifying a tag (name and category) includes.

• ADD: add a new markup
• CHANGE: change the tag of a selected markup
• OVERRIDE: change the tag to the smear text

Parameters:

tagName - the name of tag

tagCategory - the category of tag

vttObj - the vttObj Java object

ChangeSelectMarkupOperation

public static boolean ChangeSelectMarkupOperation(Markup cur,
                                                  VttObj vttObj)

Change the selected (indexed) markup with a specified markup.

Parameters:

cur - the current selected markup

vttObj - the vttObj Java object

Returns:

a boolean flag if change successfully

ClearOperation

public static void ClearOperation(VttObj vttObj)

This method clears the markup by using "Text/Clear" tag. "Text/Clear" tag is used here for the clear function. This method is not used, Delete is used instead. However, this method is kept for future usage.

Parameters:

vttObj - the vttObj Java object

UpdateModelessDialog

public static void UpdateModelessDialog(VttObj vttObj)

Update Modeless dialog, Markup and Markups dialogs

Parameters:

vttObj - the vttObj Java object

SetSelectMarkup

public static void SetSelectMarkup(int curPos,
                                   VttObj vttObj)

Set selected Markup by left mouse click (current position of caret)

Parameters:

curPos - the current (caret) position

vttObj - the vttObj Java object

ResetSelectMarkup

public static void ResetSelectMarkup(VttObj vttObj)

Reset the selected markup.

Parameters:

vttObj - the vttObj Java object

ForwardSelectMarkup

public static void ForwardSelectMarkup(boolean showAll,
                                       VttObj vttObj)

Move the select markup in forward direction.

Parameters:

showAll - the boolean flag if show all markup

vttObj - the vttObj Java object

BackwardSelectMarkup

public static void BackwardSelectMarkup(boolean showAll,
                                        VttObj vttObj)

Move the select markup in backward direction.

Parameters:

showAll - the boolean flag if show all markup

vttObj - the vttObj Java object

SetHomeSelectMarkup

public static void SetHomeSelectMarkup(boolean showAll,
                                       VttObj vttObj)

Set the select markup to the beginning of displayable markups (home).

Parameters:

showAll - the boolean flag if show all markup

vttObj - the vttObj Java object

SetEndSelectMarkup

public static void SetEndSelectMarkup(boolean showAll,
                                      VttObj vttObj)

Set the select index to the end of displayable markups (end).

Parameters:

showAll - the boolean flag if show all markup

vttObj - the vttObj Java object