/**
* Copyright 2009 DITA2InDesign project (dita2indesign.sourceforge.net) Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. n nLicensed under the Apache License, Version 2.0 (the "License"); nyou may not use this file except in compliance with the License. nYou may obtain a copy of the License at n n http://www.apache.org/licenses/LICENSE-2.0 n nUnless required by applicable law or agreed to in writing, software ndistributed under the License is distributed on an "AS IS" BASIS, nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. nSee the License for the specific language governing permissions and nlimitations under the License. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
*/
package org.dita2indesign.indesign.inx.model;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import org.apache.log4j.Logger;
import org.dita2indesign.indesign.inx.visitors.InDesignDocumentVisitor;
import org.w3c.dom.Element;
/**
* A set of one or more pages. A spread always has at least
* one page.
*/
public class Spread extends InDesignRectangleContainingObject {
private static Logger log = Logger.getLogger(Spread.class);
/**
* The index of this spread within the list of spreads
* or master spreads.
*/
private int spreadIndex = -1;
/**
* Pages indexed by object ID.
*/
protected Map<String, Page> pagesById = new HashMap<String, Page>();
/**
* Pages indexed page name (this assumes page names are unique within a spread)
*/
protected Map<String, Page> pagesByName = new HashMap<String, Page>();
/**
* Pages in document order.
*/
List<Page> pages = new ArrayList<Page>();
private TransformationMatix transformationMatrix;
/**
* @throws Exception
*
*/
public Spread() throws Exception {
super();
setInxTagName("sprd");
setPropertyFromRawValue("fsSo", "e_Dflt");
setPropertyFromRawValue("smsi", "b_t");
setPropertyFromRawValue("ilnd", "b_f");
setPropertyFromRawValue("BnLc", "l_1");
setPropertyFromRawValue("Shfl", "b_t");
}
/**
* Gets the spread index for the spread.
* @return The spread index. A value of -1 indicates the spread has not been
* placed into a document (and therefore has no meaningful index).
*/
public int getSpreadIndex() {
return this.spreadIndex;
}
/**
* @return
*/
public List<Page> getPages() {
return this.pages;
}
/**
* @param dataSource
* @param spreadIndex
* @throws Exception
*/
protected Page newPage(Element dataSource) throws Exception {
Page page = this.getDocument().newPage(dataSource);
page.setParent(this);
setPageBounds(page);
this.getDocument().registerObject(page);
this.pagesById.put(page.getId(), page);
this.pagesByName.put(page.getName(), page);
this.pages.add(page);
this.addChild(page);
setPageSide(page);
return page;
}
/**
* @param page
* @throws Exception
*/
protected void setPageSide(Page page) throws Exception {
if (getDocumentPreferences().isFacingPages()) {
int inx = this.pages.indexOf(page);
// If a page
if (this.getSpreadIndex() == 0) {
// The first spread should have exactly one page, which will
// always be a right-hand page
page.setPageSide(PageSideOption.RIGHT_HAND);
} else {
// Otherwise, first page will be left-hand (even numbered)
// subsequent pages will be right hand.
if (inx == 0) {
page.setPageSide(PageSideOption.LEFT_HAND);
} else {
page.setPageSide(PageSideOption.RIGHT_HAND);
}
}
}
}
/**
* @param page
* @throws Exception
*/
protected void setPageBounds(Page page) throws Exception {
DocumentPreferences docPrefs = getDocumentPreferences();
page.setWidth(docPrefs.getPageWidth());
page.setHeight(docPrefs.getPageHeight());
TransformationMatix matrix = page.getTransformationMatrix();
// Origin of each spread is the middle of the spread,
// so the translation from page coords to page coords
// is a downward translation of 1/2 page height:
double yTrans = 0 - (page.getHeight() / 2);
matrix.setYTranslation(yTrans);
page.setTransformationMatrix(matrix);
}
/**
* @return
*/
public DocumentPreferences getDocumentPreferences() {
return ((InDesignDocument)getParent()).getDocumentPreferences();
}
public void loadObject(Element dataSource) throws Exception {
// logger.debug("loadObject(): spreadIndex=" + spreadIndex);
super.loadObject(dataSource); // Handle master spread association
}
@Override
public void postLoad() throws Exception {
for (InDesignComponent child : this.getChildren()) {
if (child instanceof Page) {
Page page = (Page)child;
setPageBounds(page);
this.pages.add(page);
this.pagesById.put(page.getId(), page);
this.pagesByName.put(page.getName(), page);
setPageSide(page);
}
}
if (this.getName() == null) {
if (this.pages.size() > 0) {
String spreadName = this.pages.get(0).getName();
if (this.pages.size() > 1)
spreadName += "-" + this.pages.get(this.pages.size() - 1).getName();
this.setPName(spreadName);
}
}
this.assignRectanglesToPages();
log.debug("loadObject(): Spread name=\"" + this.getName() + "\"");
}
/**
* Set the spread index (the sequence number of the spread within the list of
* spreads for a document. Must be called after initial object load or
* on object creation.
* @param spreadIndex
* @throws Exception
*/
public void setSpreadIndex(int spreadIndex) throws Exception {
setTransformationMatrix(spreadIndex);
this.spreadIndex = spreadIndex;
// Pages do not literally contain frames but InDesign maintains a list of frames for each
// page.
log.debug("loadObject(): Assigning rectangles to pages()");
assignRectanglesToPages();
}
public void setTransformationMatrix(int spreadIndex) throws Exception {
log.debug("setTransformationMatrix(): Starting, spreadIndex=" + spreadIndex);
double[] matrix = {1.0, 0.0, 0.0, 1.0, 0.0, 0.0};
// The spread matrix translates spread coordinates to pasteboard
// coordinates. The horizontal coordinates are invariant, but the
// vertical dimension is translated in the positive direction for
// each spread
if (spreadIndex > 0) {
log.debug("setTransformationMatrix(): spreadIndex=" + spreadIndex);
InDesignDocument doc = (InDesignDocument)this.getParent();
double offset = doc.getSpreadOffset();
log.debug("setTransformationMatrix(): offset=" + offset);
matrix[5] = offset * spreadIndex;
}
this.transformationMatrix = new TransformationMatix(matrix);
log.debug("setTransformationMatrix(): Matrix=" + this.getTransformationMatrix());
}
/**
* @return
*/
Page getFirstPage() {
return this.pages.get(0);
}
/**
* Populate each page's list of rectangles by comparing the geometry of the
* page to the geometry of the rectangle.
* @throws Exception
*/
public void assignRectanglesToPages() throws Exception {
log.debug("assignRectanglesToPages(): Assigning rectangles to pages for spread " + this.getName() + "....");
List<Rectangle> recs = new ArrayList<Rectangle>(this.getRectangles());
log.debug("assignRectanglesToPages(): got " + recs.size() + " rectangles for spread");
log.debug("assignRectanglesToPages(): got " + pagesById.size() + " pages for spread");
for (Page page : this.getPages()) {
log.debug("assignRectanglesToPages(): Processing page " + page.getName() + " with bounding box " + page.getBoundingBox());
ListIterator<Rectangle> iter = recs.listIterator();
while (iter.hasNext()) {
Rectangle rect = iter.next();
String label = rect.getLabel();
if (label != null) {
String lbl = label;
if (label.length() > 20)
lbl = label.substring(0,20);
label = " [" + lbl + "]";
} else
label = "";
log.debug("assignRectanglesToPages(): " + rect.getClass().getSimpleName() + ": " + label + rect + "...");
if (page.intersects(rect)) {
log.debug("assignRectanglesToPages(): rect intersects page, adding to page's rect list");
page.addRectangle(rect);
if (page.contains(rect))
log.debug("assignRectanglesToPages(): Page contains rectangle, removing from master list of rectagles.");
iter.remove();
}
}
log.debug("assignRectanglesToPages(): Assigned " + page.getRectangles().size() + " to page " + page.getName());
}
log.debug("assignRectanglesToPages(): Done.");
}
/**
* Get the (first) page of the spread that is an even (left-hand) page.
* @return Page or null if there is no left-hand page. If the document
* does not use facing pages then all pages are left-hand (and right-hand)
* pages.
*/
public Page getEvenPage() {
for (Page page : getPages()) {
if (page.getPageSide() == PageSideOption.LEFT_HAND || page.getPageSide() == PageSideOption.SINGLE_SIDED)
return page;
}
return null;
}
/**
* Get the (first) page of the spread that is an odd (right-hand) page.
* @return Page or null if there is no right-hand page. If the document
* does not use facing pages then all pages are right-hand (and left-hand)
* pages.
*/
public Page getOddPage() {
for (Page page : this.getPages()) {
if (page.getPageSide() == PageSideOption.RIGHT_HAND || page.getPageSide() == PageSideOption.SINGLE_SIDED)
return page;
}
return null;
}
/**
* @return
* @throws Exception
*/
public String getName() throws Exception {
return this.getPName();
}
/**
* @return
*/
public TransformationMatix getTransformationMatrix() {
return this.transformationMatrix;
}
/**
* @param pageNumber
* @return
* @throws Exception
*/
public Page addPage(int pageNumber) throws Exception {
String pageNumberStr = String.valueOf(pageNumber);
if (this.pagesByName.containsKey(pageNumberStr))
throw new RuntimeException("Page number \"" + pageNumber + "\" already exists in spread.");
InDesignDocument doc = (InDesignDocument)this.getParent();
// Get the corresponding master page, clone its data source,
// and use that to load the page. Then adjust the bounding box
// to reflect the vertical position of the spread. Note that for
// single-spread documents the vertical translation is zero (that
// is, spread coordinates and pasteboard coordinates are the same
// for the first spread.
Page page = this.getDocument().newPage();
page.setParent(this);
page.setPName(pageNumberStr);
if (doc.isFacingPages()) {
if (pageNumber % 2 == 0) {
page.setPageSide(PageSideOption.LEFT_HAND);
} else {
page.setPageSide(PageSideOption.RIGHT_HAND);
}
} else {
page.setPageSide(PageSideOption.SINGLE_SIDED);
}
this.pagesById.put(page.getId(), page);
this.pagesByName.put(page.getPName(), page);
this.pages.add(page);
this.addChild(page);
return page;
}
/**
* @param visitor
* @throws Exception
*/
public void accept(InDesignDocumentVisitor visitor) throws Exception {
visitor.visit(this);
}
/* (non-Javadoc)
* @see org.dita2indesign.indesign.inx.model.InDesignComponent#updatePropertyMap()
*/
@Override
public void updatePropertyMap() throws Exception {
super.updatePropertyMap();
if (pages.size() == 1 && this.getSpreadIndex() == 0) {
setProperty("BnLc", new InxLong32(0)); // Left side of first page
} else {
setProperty("BnLc", new InxLong32(1)); // Two+ pages or last page is left-hand (even).
}
if (pages.size() > 0) {
setProperty("PagC", new InxInteger(pages.size()));
}
if (!hasProperty("smsi")) {
setProperty("smsi", new InxBoolean(true));
}
// Possible additional properties to handl:
// ITra -- item transform", Description = Stores the item's inner to parent transformation matrix
//
}
public void removePage(Page page) {
if (this.pages.contains(page)) {
this.pages.remove(page);
}
this.pagesById.remove(page.getId());
this.pagesByName.remove(page.getName());
}
/**
* Add new pages to the spread.
*
* @param initialPageNumber
* @param pagesToAdd
* @param master
* @throws Exception
*/
public List<Page> addPages(int initialPageNumber, int pagesToAdd) throws Exception {
List<Page> pages = new ArrayList<Page>();
for (int i = 0; i < pagesToAdd; i++) {
Page page = addPage(i + initialPageNumber);
pages.add(page);
}
return pages;
}
}