org.wandora.application.tools

Class PrintTopic

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.PrintTopic

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.KeyListener, java.io.Serializable, java.lang.Runnable, java.util.EventListener, WandoraTool, WandoraToolLogger, TopicMapLogger

public class PrintTopic
extends AbstractWandoraTool
implements java.awt.event.ActionListener, java.awt.event.KeyListener

Author:

akivela

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	PrintTopic.Preview

Field Summary

Fields

Modifier and Type	Field and Description
(package private) SimpleButton	cancelBtn
(package private) SimpleButton	copyBtn
(package private) javax.swing.JFrame	frame
(package private) javax.swing.JPanel	framePanel
protected java.lang.Object[]	keyMap
private static int	NO_SORT
static java.lang.String	OPTIONS_PREFIX
(package private) SimpleComboBox	pageSelector
(package private) Wandora	parent
(package private) PrintTopic.Preview	preview
(package private) javax.swing.JPanel	previewPanel
(package private) SimpleButton	printBtn
(package private) java.awt.print.PrinterJob	printJob
(package private) Topic	printTopic
(package private) SimpleButton	saveBtn
(package private) javax.swing.JScrollPane	scrollArea
private static int	SORT
private static int	SORT_DESC
(package private) java.util.HashMap<java.lang.String,java.lang.String>	templates
(package private) SimpleComboBox	templateSelector
(package private) javax.swing.JPanel	toolPanel

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
PrintTopic() Creates a new instance of PrintTopic

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent evt)
void	execute(Wandora admin, Context context) Runs the tool.
private void	formWindowClosing(java.awt.event.WindowEvent evt)
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
java.lang.String	getTemplateFile()
java.lang.String	getTopicAsText(Wandora admin)
java.lang.String	getTopicAsText(Wandora admin, Topic t, java.lang.String templateFile, int sortFlag)
java.lang.String	getVelocityString(Wandora admin, java.util.HashMap hash, java.lang.String templateFile)
private void	initializeGui()
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
void	setPreview(Topic t, java.lang.String template, Wandora admin)
void	setPreview(Topic t, Wandora admin)
void	solveTemplates()
java.util.ArrayList	sortArray(java.util.ArrayList v, int sortFlag)
void	updatePageSelector()
void	updatePreview()
boolean	useDefaultGui()

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, configure, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, getType, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap, writeOptions

Methods inherited from class java.lang.Object

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

Field Detail

NO_SORT

private static final int NO_SORT

See Also:

Constant Field Values

SORT_DESC

private static final int SORT_DESC

See Also:

Constant Field Values

SORT

private static final int SORT

See Also:

Constant Field Values

OPTIONS_PREFIX

public static final java.lang.String OPTIONS_PREFIX

See Also:

Constant Field Values

frame

javax.swing.JFrame frame

toolPanel

javax.swing.JPanel toolPanel

cancelBtn

SimpleButton cancelBtn

printBtn

SimpleButton printBtn

copyBtn

SimpleButton copyBtn

saveBtn

SimpleButton saveBtn

templateSelector

SimpleComboBox templateSelector

pageSelector

SimpleComboBox pageSelector

previewPanel

javax.swing.JPanel previewPanel

preview

PrintTopic.Preview preview

scrollArea

javax.swing.JScrollPane scrollArea

parent

Wandora parent

framePanel

javax.swing.JPanel framePanel

printTopic

Topic printTopic

templates

java.util.HashMap<java.lang.String,java.lang.String> templates

printJob

java.awt.print.PrinterJob printJob

keyMap

protected java.lang.Object[] keyMap

Constructor Detail

PrintTopic

public PrintTopic()

Creates a new instance of PrintTopic

Method Detail

getIcon

public javax.swing.Icon getIcon()

Description copied from class: AbstractWandoraTool

All tools may have identifying graphic icon used within tool GUI elements. getIcon should return Icon object of the tool.

Specified by:

getIcon in interface WandoraTool

Overrides:

getIcon in class AbstractWandoraTool

Returns:

icon for the tool.

getName

public java.lang.String getName()

Description copied from class: AbstractWandoraTool

Tools name represent the tool in UI unless the tool has been given explicitly another GUI name. All tools should override this method and return a valid string representing name of the tool.

Specified by:

getName in interface WandoraTool

Overrides:

getName in class AbstractWandoraTool

Returns:

String representing tool's name.

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractWandoraTool

AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu. By default description equals the tool name. All tools should override this method.

Specified by:

getDescription in interface WandoraTool

Overrides:

getDescription in class AbstractWandoraTool

Returns:

String representing tool's description.

useDefaultGui

public boolean useDefaultGui()

requiresRefresh

public boolean requiresRefresh()

Description copied from class: AbstractWandoraTool

If any visible topic has been changed during tool execution GUI is automatically refreshed. If tool doesn't change topics but GUI still requires refresh, tool should override this method and return true.

For example tools that alter the GUI but change no topics should return true.

Specified by:

requiresRefresh in interface WandoraTool

Overrides:

requiresRefresh in class AbstractWandoraTool

Returns:

true if Wandora application should refresh user interface.

execute

public void execute(Wandora admin,
                    Context context)
             throws TopicMapException

Description copied from interface: WandoraTool

Runs the tool. This is the main entry to the tool. Here the context

Specified by:

execute in interface WandoraTool

Throws:

TopicMapException

initializeGui

private void initializeGui()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent evt)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

formWindowClosing

private void formWindowClosing(java.awt.event.WindowEvent evt)

getTemplateFile

public java.lang.String getTemplateFile()

updatePreview

public void updatePreview()

setPreview

public void setPreview(Topic t,
                       Wandora admin)

setPreview

public void setPreview(Topic t,
                       java.lang.String template,
                       Wandora admin)

updatePageSelector

public void updatePageSelector()

getTopicAsText

public java.lang.String getTopicAsText(Wandora admin)

getTopicAsText

public java.lang.String getTopicAsText(Wandora admin,
                                       Topic t,
                                       java.lang.String templateFile,
                                       int sortFlag)

getVelocityString

public java.lang.String getVelocityString(Wandora admin,
                                          java.util.HashMap hash,
                                          java.lang.String templateFile)

sortArray

public java.util.ArrayList sortArray(java.util.ArrayList v,
                                     int sortFlag)

solveTemplates

public void solveTemplates()