Classes

Class	Line #	Total Statements	Complexity	Uncovered Elements	TOTAL Coverage	Actions
ImageExporter	33	44	17	60	0.00%	Show methods
ImageExporter.ImageWriterI	41	0	0	0	-1.0 -	Show methods

Class ImageExporter

Class ImageExporter	Line # 33	Total Statements 44	Complexity 17	Uncovered Elements 60	TOTAL Coverage 0.00%
ImageExporter(ImageWriterI,IProgressIndicator,TYPE,String)   ImageExporter(ImageWriterI,IProgressIndicator,TYPE,String)	6464	4.04	1.01	4.04	0.0 0.00%
run() : void   run() : void	139139	1.01	1.01	1.01	0.0 0.00%
run() : void   run() : void	150150	1.01	1.01	1.01	0.0 0.00%
doExport(File,Component,int,int,String) : void   doExport(File,Component,int,int,String) : void	8787	27.027	9.09	35.035	0.0 0.00%
exportImage(File,boolean,int,int,long) : void   exportImage(File,boolean,int,int,long) : void	183183	9.09	2.02	9.09	0.0 0.00%
setStatus(String,long) : void   setStatus(String,long) : void	216216	2.02	3.03	4.04	0.0 0.00%

 

Class ImageExporter.ImageWriterI

Class ImageExporter.ImageWriterI	Line # 41	Total Statements 0	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		package jalview.gui;
2
3		import jalview.bin.Cache;
4		import jalview.bin.Jalview;
5		import jalview.io.JalviewFileChooser;
6		import jalview.io.JalviewFileView;
7		import jalview.util.ImageMaker;
8		import jalview.util.ImageMaker.TYPE;
9		import jalview.util.MessageManager;
10		import jalview.util.dialogrunner.RunResponse;
11
12		import java.awt.Component;
13		import java.awt.Graphics;
14		import java.io.File;
15		import java.util.concurrent.atomic.AtomicBoolean;
16
17		import javax.swing.JOptionPane;
18
19		/**
20		* A class that marshals steps in exporting a view in image graphics format
21		* <ul>
22		* <li>prompts the user for the output file, if not already specified</li>
23		* <li>prompts the user for Text or Lineart character rendering, if
24		* necessary</li>
25		* <li>instantiates an ImageMaker to create the appropriate Graphics output
26		* context for the image format</li>
27		* <li>invokes a callback to do the work of writing to the graphics</li>
28		* </ul>
29		*
30		* @author gmcarstairs
31		*
32		*/
		0% Uncovered Elements: 60 (60) Complexity: 17 Complexity Density: 0.39
33		public class ImageExporter
34		{
35		// todo move interface to jalview.api? or replace with lambda?
36		/**
37		* An interface for the callback that can be run to write the image on to the
38		* graphics object. The callback should throw any exceptions arising so they
39		* can be reported by this class.
40		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
41		public interface ImageWriterI
42		{
43		void exportImage(Graphics g)
44		throws Exception;
45		}
46
47		private IProgressIndicator messageBoard;
48
49		private ImageWriterI imageWriter;
50
51		TYPE imageType;
52
53		private String title;
54
55		/**
56		* Constructor given a callback handler to write graphics data, an (optional)
57		* target for status messages, image type and (optional) title for output file
58		*
59		* @param writer
60		* @param statusBar
61		* @param type
62		* @param fileTitle
63		*/
		0% Uncovered Elements: 4 (4) Complexity: 1 Complexity Density: 0.25
64	0	public ImageExporter(ImageWriterI writer, IProgressIndicator statusBar,...
65		TYPE type, String fileTitle)
66		{
67	0	this.imageWriter = writer;
68	0	this.messageBoard = statusBar;
69	0	this.imageType = type;
70	0	this.title = fileTitle;
71		}
72
73		/**
74		* Prompts the user for output file and Text/Lineart options as required,
75		* configures a Graphics context for output, and makes a callback to the
76		* client code to perform the image output
77		*
78		* @param file
79		* output file (if null, user is prompted to choose)
80		* @param parent
81		* parent component for any dialogs shown
82		* @param width
83		* @param height
84		* @param imageSource
85		* what the image is of e.g. Tree, Alignment
86		*/
		0% Uncovered Elements: 35 (35) Complexity: 9 Complexity Density: 0.33
87	0	public void doExport(File file, Component parent, int width, int height,...
88		String imageSource)
89		{
90	0	final long messageId = System.currentTimeMillis();
91
92		/*
93		* prompt user for output file if not provided
94		*/
95	0	if (file == null && !Jalview.isHeadlessMode())
96		{
97	0	JalviewFileChooser chooser = imageType.getFileChooser();
98	0	chooser.setFileView(new JalviewFileView());
99	0	MessageManager.formatMessage("label.create_image_of",
100		imageType.getName(), imageSource);
101	0	String title = "Create " + imageType.getName()
102		+ " image from alignment";
103	0	chooser.setDialogTitle(title);
104	0	chooser.setToolTipText(MessageManager.getString("action.save"));
105	0	int value = chooser.showSaveDialog(parent);
106	0	if (value != JalviewFileChooser.APPROVE_OPTION)
107		{
108	0	String msg = MessageManager.formatMessage(
109		"status.cancelled_image_export_operation", imageType.name);
110	0	setStatus(msg, messageId);
111	0	return;
112		}
113	0	Cache.setProperty("LAST_DIRECTORY",
114		chooser.getSelectedFile().getParent());
115	0	file = chooser.getSelectedFile();
116		}
117
118		/*
119		* Prompt for Text or Lineart (EPS/SVG) unless a preference is already set
120		* for this as EPS_RENDERING / SVG_RENDERING
121		* Always set to Text for JalviewJS as Lineart (glyph fonts) not available
122		*/
123	0	String renderStyle = Cache.getDefault(
124		imageType.getName() + "_RENDERING",
125		LineartOptions.PROMPT_EACH_TIME);
126	0	if (Jalview.isJS())
127		{
128	0	renderStyle = "Text";
129		}
130	0	AtomicBoolean textSelected = new AtomicBoolean(
131		!"Lineart".equals(renderStyle));
132	0	if ((imageType == TYPE.EPS || imageType == TYPE.SVG)
133		&& LineartOptions.PROMPT_EACH_TIME.equals(renderStyle)
134		&& !Jalview.isHeadlessMode())
135		{
136	0	final File chosenFile = file;
137	0	RunResponse okAction = new RunResponse(JOptionPane.OK_OPTION)
138		{
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
139	0	@Override...
140		public void run()
141		{
142	0	exportImage(chosenFile, !textSelected.get(), width, height,
143		messageId);
144		}
145		};
146	0	LineartOptions epsOption = new LineartOptions(TYPE.EPS.getName(),
147		textSelected);
148	0	epsOption.setResponseAction(new RunResponse(JOptionPane.NO_OPTION)
149		{
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
150	0	@Override...
151		public void run()
152		{
153	0	setStatus(MessageManager.formatMessage(
154		"status.cancelled_image_export_operation",
155		imageType.getName()), messageId);
156		}
157		});
158	0	epsOption.setResponseAction(okAction);
159	0	epsOption.showDialog();
160		/* no code here - JalviewJS cannot execute it */
161		}
162		else
163		{
164		/*
165		* character rendering not required, or preference already set
166		* - just do the export
167		*/
168	0	exportImage(file, !textSelected.get(), width, height, messageId);
169		}
170		}
171
172		/**
173		* Constructs a suitable graphics context and passes it to the callback
174		* handler for the image to be written. Shows status messages for export in
175		* progress, complete, or failed as appropriate.
176		*
177		* @param chosenFile
178		* @param asLineart
179		* @param width
180		* @param height
181		* @param messageId
182		*/
		0% Uncovered Elements: 9 (9) Complexity: 2 Complexity Density: 0.22
183	0	protected void exportImage(File chosenFile, boolean asLineart, int width,...
184		int height, long messageId)
185		{
186	0	String type = imageType.getName();
187	0	try
188		{
189	0	setStatus(
190		MessageManager.formatMessage(
191		"status.exporting_alignment_as_x_file", type),
192		messageId);
193	0	ImageMaker im = new ImageMaker(imageType, width, height, chosenFile,
194		title, asLineart);
195	0	imageWriter.exportImage(im.getGraphics());
196	0	im.writeImage();
197	0	setStatus(
198		MessageManager.formatMessage("status.export_complete", type),
199		messageId);
200		} catch (Exception e)
201		{
202	0	System.out
203		.println(String.format("Error creating %s file: %s", type,
204		e.toString()));
205	0	setStatus(MessageManager.formatMessage("info.error_creating_file",
206		type), messageId);
207		}
208		}
209
210		/**
211		* Asks the callback to show a status message with given id
212		*
213		* @param msg
214		* @param id
215		*/
		0% Uncovered Elements: 4 (4) Complexity: 3 Complexity Density: 1.5
216	0	void setStatus(String msg, long id)...
217		{
218	0	if (messageBoard != null && !Jalview.isHeadlessMode())
219		{
220	0	messageBoard.setProgressBar(msg, id);
221		}
222		}
223
224		}