Support cover images in EPUB export + some full screen image improvements

git-svn-id: svn://svn.code.sf.net/p/writer2latex/code/trunk@112 f0f2a975-2e09-46c8-9428-3b39399b9f3c
This commit is contained in:
henrikjust 2011-06-19 13:39:56 +00:00
parent 63e9c4c66d
commit e09d61f6ee
16 changed files with 202 additions and 117 deletions

View file

@ -20,7 +20,7 @@
*
* All Rights Reserved.
*
* Version 1.2 (2011-06-16)
* Version 1.2 (2011-06-19)
*
*/
@ -102,6 +102,7 @@ public class EpubOptionsDialog extends OptionsDialogBase {
loadListBoxOption(xProps, "PageBreakSplit");
loadCheckBoxOption(xProps, "UseImageSplit");
loadNumericOption(xProps, "ImageSplit");
loadCheckBoxOption(xProps, "CoverImage");
loadCheckBoxOption(xProps, "UseSplitAfter");
loadNumericOption(xProps, "SplitAfter");
@ -175,6 +176,8 @@ public class EpubOptionsDialog extends OptionsDialogBase {
helper.put("image_split", "none");
}
}
saveCheckBoxOption(xProps, helper, "CoverImage", "cover_image");
boolean bUseSplitAfter = saveCheckBoxOption(xProps, "UseSplitAfter");
int nSplitAfter = saveNumericOption(xProps, "SplitAfter");
@ -206,9 +209,6 @@ public class EpubOptionsDialog extends OptionsDialogBase {
else if (sMethod.equals("UseDefaultFontChange")) {
useDefaultFontChange();
}
else if (sMethod.equals("ImageSizeChange")) {
imageSizeChange();
}
else if (sMethod.equals("EditMetadataClick")) {
editMetadataClick();
}
@ -270,6 +270,8 @@ public class EpubOptionsDialog extends OptionsDialogBase {
setControlEnabled("ImageSplit",!isLocked("image_split") && bUseImageSplit);
setControlEnabled("ImageSplitPercentLabel",!isLocked("image_split") && bUseImageSplit);
setControlEnabled("CoverImage", !isLocked("cover_image"));
boolean bUseSplitAfter = getCheckBoxStateAsBoolean("UseSplitAfter");
setControlEnabled("UseSplitAfter",!isLocked("split_after"));
setControlEnabled("SplitAfterLabel",!isLocked("split_after") && bUseSplitAfter);
@ -298,13 +300,6 @@ public class EpubOptionsDialog extends OptionsDialogBase {
}
}
private void imageSizeChange() {
if (!isLocked("image_split")) {
setControlEnabled("UseImageSplit", getListBoxSelectedItem("ImageSize")==1);
useImageSplitChange();
}
}
private void editMetadataClick() {
Object dialog;
try {
@ -324,7 +319,7 @@ public class EpubOptionsDialog extends OptionsDialogBase {
private void useImageSplitChange() {
if (!isLocked("image_split")) {
boolean bEnable = getCheckBoxStateAsBoolean("UseImageSplit") && (getListBoxSelectedItem("ImageSize")==1);
boolean bEnable = getCheckBoxStateAsBoolean("UseImageSplit");
setControlEnabled("ImageSplitLabel",bEnable);
setControlEnabled("ImageSplit",bEnable);
setControlEnabled("ImageSplitPercentLabel",bEnable);

View file

@ -20,7 +20,7 @@
*
* All Rights Reserved.
*
* Version 1.2 (2011-06-16)
* Version 1.2 (2011-06-19)
*
*/
@ -33,7 +33,7 @@ public class ConverterFactory {
// Version information
private static final String VERSION = "1.1.8";
private static final String DATE = "2011-06-16";
private static final String DATE = "2011-06-19";
/** Return the Writer2LaTeX version in the form
* (major version).(minor version).(patch level)<br/>

View file

@ -16,11 +16,11 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
* Copyright: 2002-2010 by Henrik Just
* Copyright: 2002-2011 by Henrik Just
*
* All Rights Reserved.
*
* Version 1.2 (2010-04-13)
* Version 1.2 (2011-06-19)
*
*/
@ -105,6 +105,14 @@ public interface ConverterResult {
*/
public ContentEntry getBibliographyFile();
/** Get the entry which contains the cover image
*
* @return the entry or null if a cover image does not exist
*/
public ContentEntry getCoverImageFile();
/** Write all files of the <code>ConverterResult</code> to a directory.
* Subdirectories are created as required by the individual
* <code>OutputFile</code>s.

View file

@ -16,11 +16,11 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
* Copyright: 2002-2010 by Henrik Just
* Copyright: 2002-2011 by Henrik Just
*
* All Rights Reserved.
*
* Version 1.2 (2010-04-13)
* Version 1.2 (2011-06-19)
*
*/
@ -53,6 +53,7 @@ public class ConverterResultImpl implements ConverterResult {
private ContentEntry lotFile;
private ContentEntry indexFile;
private ContentEntry bibliographyFile;
private ContentEntry coverImageFile;
private MetaData metaData = null;
@ -77,6 +78,7 @@ public class ConverterResultImpl implements ConverterResult {
lotFile = null;
indexFile = null;
bibliographyFile = null;
coverImageFile = null;
metaData = null;
nMasterCount = 0;
}
@ -209,6 +211,18 @@ public class ConverterResultImpl implements ConverterResult {
return bibliographyFile;
}
/** Define the entry which contains the cover image
*
* @param entry the entry
*/
public void setCoverImageFile(ContentEntry entry) {
coverImageFile = entry;
}
public ContentEntry getCoverImageFile() {
return coverImageFile;
}
/** Set the meta data of this <code>ConverterResult</code>
*
* @param metaData the meta data

View file

@ -16,11 +16,11 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
* Copyright: 2002-2010 by Henrik Just
* Copyright: 2002-2011 by Henrik Just
*
* All Rights Reserved.
*
* Version 1.2 (2010-10-27)
* Version 1.2 (2011-06-16)
*
*/
@ -308,6 +308,9 @@ public class OfficeReader {
// The main content element
private Element content = null;
// The first image in the document
private Element firstImage = null;
// Identify OASIS OpenDocument format
private boolean bOpenDocument = false;
@ -705,6 +708,14 @@ public class OfficeReader {
public TableReader getTableReader(Element node) {
return new TableReader(this,node);
}
/** Get the very first image in this document, if any
*
* @return the first image, or null if no images exists
*/
public Element getFirstImage() {
return firstImage;
}
/** Constructor; read a document */
public OfficeReader(OfficeDocument oooDoc, boolean bAllParagraphsAreSoft) {
@ -1122,6 +1133,11 @@ public class OfficeReader {
}
}
// todo: other indexes
else if (firstImage==null && sName.equals(XMLString.DRAW_FRAME)) {
// This may be an image (note that a replacement image for an object is OK by this definition)
Element image = Misc.getChildByTagName(node, XMLString.DRAW_IMAGE);
if (image!=null) { firstImage=image; }
}
// Traverse the children
Node child = node.getFirstChild();

View file

@ -20,7 +20,7 @@
*
* All Rights Reserved.
*
* Version 1.2 (2011-06-07)
* Version 1.2 (2011-06-19)
*
*/
@ -217,6 +217,10 @@ public class Converter extends ConverterBase {
converterResult.setIndexFile(new ContentEntryImpl(l10n.get(L10n.INDEX),1,htmlDoc,sTarget));
nAlphabeticalIndex = nOutFileIndex;
}
protected void setCoverImageFile(String sTarget) {
converterResult.setCoverImageFile(new ContentEntryImpl("Cover image",0,htmlDoc,sTarget));
}
protected Element createElement(String s) { return htmlDOM.createElement(s); }

View file

@ -20,7 +20,7 @@
*
* All Rights Reserved.
*
* Version 1.2 (2011-06-16)
* Version 1.2 (2011-06-19)
*
*/
@ -97,6 +97,7 @@ public class DrawConverter extends ConverterHelper {
private boolean bConvertToPx;
private int nImageSize;
private String sImageSplit;
private boolean bCoverImage;
// Frames in spreadsheet documents are collected here
private Vector<Element> frames = new Vector<Element>();
@ -106,7 +107,7 @@ public class DrawConverter extends ConverterHelper {
// Large images (for full screen) in EPUB export are collected here
private Vector<Element> fullscreenFrames = new Vector<Element>();
// This flag determines whether to collect full screen images or insert them immediately
private boolean bCollectFullscreenFrames = false;
private boolean bCollectFullscreenFrames = true;
public DrawConverter(OfficeReader ofr, XhtmlConfig config, Converter converter) {
super(ofr,config,converter);
@ -122,8 +123,9 @@ public class DrawConverter extends ConverterHelper {
bConvertToPx = config.xhtmlConvertToPx();
nImageSize = config.imageSize();
sImageSplit = config.imageSplit();
bCoverImage = config.coverImage();
}
///////////////////////////////////////////////////////////////////////
// Complete Draw documents/presentations
@ -230,20 +232,36 @@ public class DrawConverter extends ConverterHelper {
else return onode;
}
// Add cover image (the first image in the document is taken out of context)
public Element insertCoverImage(Element hnode) {
Element currentNode = hnode;
if (bCoverImage) {
Element cover = ofr.getFirstImage();
if (cover!=null) {
converter.setCoverImageFile(null);
bCollectFullscreenFrames = false;
handleDrawElement(cover,currentNode,null,FULL_SCREEN);
bCollectFullscreenFrames = true;
currentNode = getTextCv().doMaybeSplit(hnode, 0);
}
}
return currentNode;
}
// Flush all full screen images, returning the new document node
public Element flushFullscreenFrames(Element hnode) {
Element currentFrame = hnode;
Element currentNode = hnode;
if (converter.isTopLevel() && !fullscreenFrames.isEmpty()) {
bCollectFullscreenFrames = false;
currentFrame = getTextCv().doMaybeSplit(hnode, 0);
currentNode = getTextCv().doMaybeSplit(hnode, 0);
for (Element image : fullscreenFrames) {
handleDrawElement(image,currentFrame,null,FULL_SCREEN);
currentFrame = getTextCv().doMaybeSplit(hnode, 0);
handleDrawElement(image,currentNode,null,FULL_SCREEN);
currentNode = getTextCv().doMaybeSplit(hnode, 0);
}
fullscreenFrames.clear();
bCollectFullscreenFrames = true;
}
return currentFrame;
return currentNode;
}
public void flushFrames(Element hnode) {
@ -400,23 +418,28 @@ public class DrawConverter extends ConverterHelper {
private void handleDrawImage(Element onode, Element hnodeBlock, Element hnodeInline, int nMode) {
Element frame = getFrame(onode);
// First check to see if we should treat this image as a "full screen" image
// This is only supported for EPUB documents with relative image size
// (Currently only images are handled like this, hence the code is here rather than in handleDrawElement)
if (bCollectFullscreenFrames && converter.isOPS() && nImageSize==XhtmlConfig.RELATIVE && !"none".equals(sImageSplit)
&& converter.isTopLevel()) {
StyleWithProperties style = ofr.getFrameStyle(frame.getAttribute(XMLString.DRAW_STYLE_NAME));
String sWidth = getFrameWidth(frame, style);
String sHeight = getFrameHeight(frame, style);
// It is if the image width exceeds a certain percentage of the current text width and the height is
// greater than 1.33*the width (recommended by Michel "Coolmicro")
if (sWidth!=null && sHeight!=null &&
Misc.sub(Misc.multiply("133%",sWidth), sHeight).startsWith("-") &&
Misc.sub(Misc.multiply(sImageSplit,converter.getContentWidth()),
Misc.multiply(sScale,Misc.truncateLength(sWidth))).startsWith("-")) {
fullscreenFrames.add(onode);
// For EPUB document some images require special treatment: Cover image and full screen images
if (bCollectFullscreenFrames && converter.isOPS()) {
// First check whether this is the cover image
if (bCoverImage && onode==ofr.getFirstImage()) {
return;
}
// Next check to see if we should treat this image as a "full screen" image
// (Currently only images are handled like this, hence the code is here rather than in handleDrawElement)
else if (!"none".equals(sImageSplit) && converter.isTopLevel()) {
StyleWithProperties style = ofr.getFrameStyle(frame.getAttribute(XMLString.DRAW_STYLE_NAME));
String sWidth = getFrameWidth(frame, style);
String sHeight = getFrameHeight(frame, style);
// It is if the image width exceeds a certain percentage of the current text width and the height is
// greater than 1.33*the width (recommended by Michel "Coolmicro")
if (sWidth!=null && sHeight!=null &&
Misc.sub(Misc.multiply("133%",sWidth), sHeight).startsWith("-") &&
Misc.sub(Misc.multiply(sImageSplit,converter.getContentWidth()),
Misc.multiply(sScale,Misc.truncateLength(sWidth))).startsWith("-")) {
fullscreenFrames.add(onode);
return;
}
}
}
// Get the image from the ImageLoader
@ -462,7 +485,7 @@ public class DrawConverter extends ConverterHelper {
StyleInfo info = new StyleInfo();
String sStyleName = Misc.getAttribute(frame, XMLString.DRAW_STYLE_NAME);
if (nMode!=FULL_SCREEN) { getFrameSc().applyStyle(sStyleName,info); }
applyImageSize(frame,info.props,false);
applyImageSize(frame,info.props,nMode,false);
// Apply placement
applyPlacement(frame, hnodeBlock, hnodeInline, nMode, image, info);
@ -513,7 +536,7 @@ public class DrawConverter extends ConverterHelper {
case INLINE:
break;
case ABSOLUTE:
sContentWidth = applyImageSize(frame,info.props,false);
sContentWidth = applyImageSize(frame,info.props,nMode,false);
info.props.addValue("margin-left","auto");
info.props.addValue("margin-right","auto");
applyPosition(frame,info.props);
@ -523,10 +546,10 @@ public class DrawConverter extends ConverterHelper {
info.props.addValue("margin-bottom","2px");
info.props.addValue("margin-left","auto");
info.props.addValue("margin-right","auto");
sContentWidth = applyImageSize(frame,info.props,true);
sContentWidth = applyImageSize(frame,info.props,nMode,true);
break;
case FLOATING:
sContentWidth = applyImageSize(frame,info.props,true);
sContentWidth = applyImageSize(frame,info.props,nMode,true);
StyleWithProperties style = ofr.getFrameStyle(sStyleName);
if (style!=null) {
String sPos = style.getProperty(XMLString.STYLE_HORIZONTAL_POS);
@ -918,28 +941,25 @@ public class DrawConverter extends ConverterHelper {
// TODO: For absolute placement, only absolute size makes sense
// TODO: How to handle NONE in case of text boxes? (currently using browser default, usually 100% width)
private String applyImageSize(Element node, CSVList props, boolean bOnlyWidth) {
if (bCollectFullscreenFrames) { // Normal image
switch (nImageSize) {
case XhtmlConfig.ABSOLUTE:
return applySize(node, props, bOnlyWidth);
case XhtmlConfig.RELATIVE:
private String applyImageSize(Element node, CSVList props, int nMode, boolean bOnlyWidth) {
switch (nImageSize) {
case XhtmlConfig.ABSOLUTE:
return applySize(node, props, bOnlyWidth);
case XhtmlConfig.RELATIVE:
if (nMode==FULL_SCREEN) {
props.addValue("max-width","100%");
props.addValue("height","100%");
}
else {
String sWidth = getFrameWidth(node, ofr.getFrameStyle(node.getAttribute(XMLString.DRAW_STYLE_NAME)));
if (sWidth!=null) {
props.addValue("width", Misc.divide(Misc.multiply(sScale,Misc.truncateLength(sWidth)),converter.getContentWidth()));
}
return sWidth;
case XhtmlConfig.NONE:
// Nothing to do :-)
return getFrameWidth(node, ofr.getFrameStyle(node.getAttribute(XMLString.DRAW_STYLE_NAME)));
}
}
else { // Full screen image
props.addValue("max-width","100%");
props.addValue("height","100%");
props.addValue("display","block");
props.addValue("margin-left","auto");
props.addValue("margin-right","auto");
case XhtmlConfig.NONE:
// Nothing to do :-)
return getFrameWidth(node, ofr.getFrameStyle(node.getAttribute(XMLString.DRAW_STYLE_NAME)));
}
return null;
}
@ -990,7 +1010,10 @@ public class DrawConverter extends ConverterHelper {
break;
case FULL_SCREEN:
if (hnodeBlock!=null) {
hnodeBlock.appendChild(object);
Element div = converter.createElement("div");
div.setAttribute("style", "text-align:center");
hnodeBlock.appendChild(div);
div.appendChild(object);
}
break;
case FLOATING:

View file

@ -189,6 +189,9 @@ public class TextConverter extends ConverterHelper {
hnode = form;
}
}
// Add cover image
hnode = getDrawCv().insertCoverImage(hnode);
// Convert content
hnode = (Element)traverseBlockText(onode,hnode);

View file

@ -41,7 +41,7 @@ import writer2latex.util.Misc;
public class XhtmlConfig extends writer2latex.base.ConfigBase {
// Implement configuration methods
protected int getOptionCount() { return 55; }
protected int getOptionCount() { return 56; }
protected String getDefaultConfigPath() { return "/writer2latex/xhtml/config/"; }
// Override setOption: To be backwards compatible, we must accept options
@ -136,19 +136,20 @@ public class XhtmlConfig extends writer2latex.base.ConfigBase {
private static final int PAGE_BREAK_SPLIT = 39;
private static final int SPLIT_AFTER = 40;
private static final int IMAGE_SPLIT = 41;
private static final int CALC_SPLIT = 42;
private static final int DISPLAY_HIDDEN_SHEETS = 43;
private static final int DISPLAY_HIDDEN_ROWS_COLS = 44;
private static final int DISPLAY_FILTERED_ROWS_COLS = 45;
private static final int APPLY_PRINT_RANGES = 46;
private static final int USE_TITLE_AS_HEADING = 47;
private static final int USE_SHEET_NAMES_AS_HEADINGS = 48;
private static final int XSLT_PATH = 49;
private static final int SAVE_IMAGES_IN_SUBDIR = 50;
private static final int UPLINK = 51;
private static final int DIRECTORY_ICON = 52;
private static final int DOCUMENT_ICON = 53;
private static final int ZEN_HACK = 54; // temporary hack for ePub Zen Garden styles
private static final int COVER_IMAGE = 42;
private static final int CALC_SPLIT = 43;
private static final int DISPLAY_HIDDEN_SHEETS = 44;
private static final int DISPLAY_HIDDEN_ROWS_COLS = 45;
private static final int DISPLAY_FILTERED_ROWS_COLS = 46;
private static final int APPLY_PRINT_RANGES = 47;
private static final int USE_TITLE_AS_HEADING = 48;
private static final int USE_SHEET_NAMES_AS_HEADINGS = 49;
private static final int XSLT_PATH = 50;
private static final int SAVE_IMAGES_IN_SUBDIR = 51;
private static final int UPLINK = 52;
private static final int DIRECTORY_ICON = 53;
private static final int DOCUMENT_ICON = 54;
private static final int ZEN_HACK = 55; // temporary hack for ePub Zen Garden styles
protected ComplexOption xheading = addComplexOption("heading-map");
protected ComplexOption xpar = addComplexOption("paragraph-map");
@ -258,6 +259,7 @@ public class XhtmlConfig extends writer2latex.base.ConfigBase {
}
};
options[IMAGE_SPLIT] = new Option("image_split","none");
options[COVER_IMAGE] = new BooleanOption("cover_image","false");
options[CALC_SPLIT] = new BooleanOption("calc_split","false");
options[DISPLAY_HIDDEN_SHEETS] = new BooleanOption("display_hidden_sheets", "false");
options[DISPLAY_HIDDEN_ROWS_COLS] = new BooleanOption("display_hidden_rows_cols","false");
@ -383,6 +385,7 @@ public class XhtmlConfig extends writer2latex.base.ConfigBase {
public int pageBreakSplit() { return ((IntegerOption) options[PAGE_BREAK_SPLIT]).getValue(); }
public int splitAfter() { return ((IntegerOption) options[SPLIT_AFTER]).getValue(); }
public String imageSplit() { return options[IMAGE_SPLIT].getString(); }
public boolean coverImage() { return ((BooleanOption) options[COVER_IMAGE]).getValue(); }
public boolean xhtmlCalcSplit() { return ((BooleanOption) options[CALC_SPLIT]).getValue(); }
public boolean xhtmlDisplayHiddenSheets() { return ((BooleanOption) options[DISPLAY_HIDDEN_SHEETS]).getValue(); }
public boolean displayHiddenRowsCols() { return ((BooleanOption) options[DISPLAY_HIDDEN_ROWS_COLS]).getValue(); }