org.sleuthkit.autopsy.contentviewers.TranslatablePanel Class Reference

Inherits JPanel.

Classes
interface	ContentComponent
class	OnTranslation
class	TranslatablePanelException
class	TranslatedText
class	TranslateOption

Public Member Functions
	TranslatablePanel (ContentComponent contentComponent)

Private Attributes
volatile OnTranslation	backgroundTask = null
final Object	backgroundTaskLock = new Object()
volatile TranslatedText	cachedTranslated
final Object	cachedTranslatedLock = new Object()
String	content
final ContentComponent	contentComponent
String	contentDescriptor
final ExecutorService	executorService = Executors.newSingleThreadExecutor(translationThreadFactory)
boolean	prevTranslateSelection
final TextTranslationService	translationService
final ThreadFactory	translationThreadFactory = new ThreadFactoryBuilder().setNameFormat("translatable-panel-%d").build()
final ImageIcon	warningIcon = new ImageIcon(TranslatablePanel.class.getResource("/org/sleuthkit/autopsy/images/warning16.png"))

Static Private Attributes
static final ComponentOrientation	DEFAULT_ORIENTATION = ComponentOrientation.LEFT_TO_RIGHT
static final long	serialVersionUID = 1L
javax.swing.JLabel	statusLabel
javax.swing.JComboBox< TranslateOption >	translateComboBox
javax.swing.JPanel	translationBar
final void	reset ()
void	setContent (String content, String contentDescriptor)
TranslatedText	getCachedTranslated ()
void	setCachedTranslated (TranslatedText translated)
void	cancelPendingTranslation ()
void	runTranslationTask ()
void	clearStatus ()
synchronized void	setStatus (String msg, boolean showWarningIcon)
void	setTranslationEnabled ()
void	setChildComponentContent (String content)
synchronized void	setChildComponentContent (String content, ComponentOrientation orientation)
void	additionalInit (Component rootComponent, String origOptionText, String translatedOptionText)
void	handleComboBoxChange (TranslateOption translateOption)
void	initComponents ()
void	translateComboBoxActionPerformed (java.awt.event.ActionEvent evt)
String	retrieveTranslation (String input) throws TranslationException, NoServiceProviderException

Detailed Description

This is a panel for translation with a subcomponent that allows for translation.

Definition at line 40 of file TranslatablePanel.java.

Constructor & Destructor Documentation

TranslatablePanel()

org.sleuthkit.autopsy.contentviewers.TranslatablePanel.TranslatablePanel

(

ContentComponent

contentComponent

)

Definition at line 194 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.additionalInit(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.contentComponent, org.sleuthkit.autopsy.texttranslation.TextTranslationService.getInstance(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.ContentComponent.getRootComponent(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.initComponents(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.reset(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translationService.

Member Function Documentation

additionalInit()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.additionalInit ( Component  rootComponent, String  origOptionText, String  translatedOptionText  )

private

This method is for items that are programmatically initialized.

Definition at line 351 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBox.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.TranslatablePanel().

cancelPendingTranslation()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cancelPendingTranslation ( )

private

If a translation worker is running, this is called to cancel the worker.

Definition at line 239 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.backgroundTaskLock.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.handleComboBoxChange(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.runTranslationTask(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent().

clearStatus()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.clearStatus ( )

private

This method clears the status bar.

Definition at line 303 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setStatus().

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.handleComboBoxChange(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.OnTranslation.onTextDisplay(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent().

getCachedTranslated()

TranslatedText org.sleuthkit.autopsy.contentviewers.TranslatablePanel.getCachedTranslated ( )

private

Returns

the cached translated text or returns null

Definition at line 221 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cachedTranslated, and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cachedTranslatedLock.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.handleComboBoxChange().

handleComboBoxChange()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.handleComboBoxChange ( TranslateOption  translateOption )

private

When the combo box choice is selected, this method is fired.

Parameters

translateOption

the current translate option

Definition at line 362 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cancelPendingTranslation(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.clearStatus(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.getCachedTranslated(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.runTranslationTask(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setChildComponentContent().

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBoxActionPerformed().

initComponents()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.initComponents ( )

private

This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.

Definition at line 390 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.statusLabel, org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBox, org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBoxActionPerformed(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translationBar.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.TranslatablePanel().

reset()

final void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.reset

(

)

This resets the component to an empty state and sets the translation bar visibility based on whether there is a provider.

Definition at line 266 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent().

Referenced by org.sleuthkit.autopsy.contentviewers.artifactviewers.MessageArtifactViewer.resetComponent(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.TranslatablePanel().

retrieveTranslation()

String org.sleuthkit.autopsy.contentviewers.TranslatablePanel.retrieveTranslation ( String  input ) throws TranslationException, NoServiceProviderException

protected

This is where actual translation takes place allowed to be overridden for the sake of varying translatable content (i.e. html, rtf, etc).

Parameters

input

the input content

Returns

the result of translation

Exceptions

TranslationException
NoServiceProviderException

Definition at line 296 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.texttranslation.TextTranslationService.translate().

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.OnTranslation.translate().

runTranslationTask()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.runTranslationTask ( )

private

This runs a translation worker to translate the text.

Definition at line 251 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.backgroundTaskLock, and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cancelPendingTranslation().

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.handleComboBoxChange().

setCachedTranslated()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setCachedTranslated ( TranslatedText  translated )

private

Parameters

translated

the translated text to be cached

Definition at line 230 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cachedTranslatedLock.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.OnTranslation.onTextDisplay(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent().

setChildComponentContent() [1/2]

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setChildComponentContent ( String  content )

private

The child component provided in the constructor will have its content set to the string provided.

Parameters

content

the content to display in the child component

Definition at line 328 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.handleComboBoxChange(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.OnTranslation.onTextDisplay(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent().

setChildComponentContent() [2/2]

synchronized void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setChildComponentContent ( String  content, ComponentOrientation  orientation  )

private

The child component provided in the constructor will have its content set to the string provided.

Parameters

content	the content to display in the child component
orientation	the orientation for the text

Definition at line 338 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.ContentComponent.setContent(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setStatus().

setContent()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent	(	String	content,
		String	contentDescriptor
	)

This method sets the content for the component; this also clears the status.

Parameters

content	the content for the panel
contentDescriptor	the content descriptor to be used in error messages

Definition at line 275 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cancelPendingTranslation(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.clearStatus(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.content, org.sleuthkit.autopsy.contentviewers.TranslatablePanel.contentDescriptor, org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setCachedTranslated(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setChildComponentContent(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setTranslationEnabled(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBox.

Referenced by org.sleuthkit.autopsy.contentviewers.artifactviewers.MessageArtifactViewer.configureTextArea(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.reset().

setStatus()

synchronized void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setStatus ( String  msg, boolean  showWarningIcon  )

private

This sets the status bar message.

Parameters

msg	the status bar message to show
showWarningIcon	whether that status is a warning

Definition at line 312 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.statusLabel.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.clearStatus(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.OnTranslation.onErrorDisplay(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.OnTranslation.onProgressDisplay(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setChildComponentContent().

setTranslationEnabled()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setTranslationEnabled ( )

private

This method sets the translation bar visibility based on whether or not there is a provided.

Definition at line 320 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.texttranslation.TextTranslationService.hasProvider(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBox.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent().

translateComboBoxActionPerformed()

void org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBoxActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 425 of file TranslatablePanel.java.

References org.sleuthkit.autopsy.contentviewers.TranslatablePanel.handleComboBoxChange(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBox.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.initComponents().

Member Data Documentation

backgroundTask

volatile OnTranslation org.sleuthkit.autopsy.contentviewers.TranslatablePanel.backgroundTask = null

private

Definition at line 190 of file TranslatablePanel.java.

backgroundTaskLock

final Object org.sleuthkit.autopsy.contentviewers.TranslatablePanel.backgroundTaskLock = new Object()

private

Definition at line 183 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cancelPendingTranslation(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.runTranslationTask().

cachedTranslated

volatile TranslatedText org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cachedTranslated

private

Definition at line 189 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.getCachedTranslated().

cachedTranslatedLock

final Object org.sleuthkit.autopsy.contentviewers.TranslatablePanel.cachedTranslatedLock = new Object()

private

Definition at line 182 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.getCachedTranslated(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setCachedTranslated().

content

String org.sleuthkit.autopsy.contentviewers.TranslatablePanel.content

private

Definition at line 185 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.OnTranslation.retrieveText(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent().

contentComponent

final ContentComponent org.sleuthkit.autopsy.contentviewers.TranslatablePanel.contentComponent

private

Definition at line 177 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.TranslatablePanel().

contentDescriptor

String org.sleuthkit.autopsy.contentviewers.TranslatablePanel.contentDescriptor

private

Definition at line 186 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent().

DEFAULT_ORIENTATION

final ComponentOrientation org.sleuthkit.autopsy.contentviewers.TranslatablePanel.DEFAULT_ORIENTATION = ComponentOrientation.LEFT_TO_RIGHT

staticprivate

Definition at line 173 of file TranslatablePanel.java.

executorService

final ExecutorService org.sleuthkit.autopsy.contentviewers.TranslatablePanel.executorService = Executors.newSingleThreadExecutor(translationThreadFactory)

private

Definition at line 180 of file TranslatablePanel.java.

prevTranslateSelection

boolean org.sleuthkit.autopsy.contentviewers.TranslatablePanel.prevTranslateSelection

private

Definition at line 187 of file TranslatablePanel.java.

serialVersionUID

final long org.sleuthkit.autopsy.contentviewers.TranslatablePanel.serialVersionUID = 1L

staticprivate

Definition at line 172 of file TranslatablePanel.java.

statusLabel

javax.swing.JLabel org.sleuthkit.autopsy.contentviewers.TranslatablePanel.statusLabel

private

Definition at line 430 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.initComponents(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setStatus().

translateComboBox

javax.swing.JComboBox<TranslateOption> org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBox

private

Definition at line 431 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.additionalInit(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.initComponents(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setContent(), org.sleuthkit.autopsy.contentviewers.TranslatablePanel.setTranslationEnabled(), and org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translateComboBoxActionPerformed().

translationBar

javax.swing.JPanel org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translationBar

private

Definition at line 432 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.initComponents().

translationService

final TextTranslationService org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translationService

private

Definition at line 178 of file TranslatablePanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.TranslatablePanel.TranslatablePanel().

translationThreadFactory

final ThreadFactory org.sleuthkit.autopsy.contentviewers.TranslatablePanel.translationThreadFactory = new ThreadFactoryBuilder().setNameFormat("translatable-panel-%d").build()

private

Definition at line 179 of file TranslatablePanel.java.

warningIcon

final ImageIcon org.sleuthkit.autopsy.contentviewers.TranslatablePanel.warningIcon = new ImageIcon(TranslatablePanel.class.getResource("/org/sleuthkit/autopsy/images/warning16.png"))

private

Definition at line 175 of file TranslatablePanel.java.

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/dox-to-sphinx/checkouts/latest/Core/src/org/sleuthkit/autopsy/contentviewers/TranslatablePanel.java