1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
|
/*
* $Id: Section.java,v 1.53 2002/07/09 10:41:40 blowagie Exp $
* $Name: $
*
* Copyright 1999, 2000, 2001, 2002 by Bruno Lowagie.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.Properties;
/**
* A <CODE>Section</CODE> is a part of a <CODE>Document</CODE> containing
* other <CODE>Section</CODE>s, <CODE>Paragraph</CODE>s, <CODE>List</CODE>
* and/or <CODE>Table</CODE>s.
* <P>
* Remark: you can not construct a <CODE>Section</CODE> yourself.
* You will have to ask an instance of <CODE>Section</CODE> to the
* <CODE>Chapter</CODE> or <CODE>Section</CODE> to which you want to
* add the new <CODE>Section</CODE>.
* <P>
* Example:
* <BLOCKQUOTE><PRE>
* Paragraph title2 = new Paragraph("This is Chapter 2", FontFactory.getFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));
* Chapter chapter2 = new Chapter(title2, 2);
* Paragraph someText = new Paragraph("This is some text");
* chapter2.add(someText);
* Paragraph title21 = new Paragraph("This is Section 1 in Chapter 2", FontFactory.getFont(FontFactory.HELVETICA, 16, Font.BOLD, new Color(255, 0, 0)));
* <STRONG>Section section1 = chapter2.addSection(title21);</STRONG>
* Paragraph someSectionText = new Paragraph("This is some silly paragraph in a chapter and/or section. It contains some text to test the functionality of Chapters and Section.");
* <STRONG>section1.add(someSectionText);</STRONG>
* Paragraph title211 = new Paragraph("This is SubSection 1 in Section 1 in Chapter 2", FontFactory.getFont(FontFactory.HELVETICA, 14, Font.BOLD, new Color(255, 0, 0)));
* <STRONG>Section section11 = section1.addSection(40, title211, 2);<STRONG>
* <STRONG>section11.add(someSectionText);<STRONG>
* </PRE></BLOCKQUOTE>
*/
public class Section extends ArrayList implements TextElementArray {
// membervariables
/** This is the title of this section. */
protected Paragraph title;
/** This is the number of sectionnumbers that has to be shown before the section title. */
protected int numberDepth;
/** The indentation of this section on the left side. */
protected float indentationLeft;
/** The indentation of this section on the right side. */
protected float indentationRight;
/** The additional indentation of the content of this section. */
protected float sectionIndent;
/** This is the number of subsections. */
protected int subsections = 0;
/** This is the complete list of sectionnumbers of this section and the parents of this section. */
protected ArrayList numbers = null;
/** false if the bookmark children are not visible */
protected boolean bookmarkOpen = true;
// constructors
/**
* Constructs a new <CODE>Section</CODE>.
*/
protected Section() {
title = new Paragraph();
numberDepth = 1;
}
/**
* Constructs a new <CODE>Section</CODE>.
*
* @param title a <CODE>Paragraph</CODE>
* @param numberDepth the numberDepth
*/
Section(Paragraph title, int numberDepth) {
this.numberDepth = numberDepth;
this.title = title;
}
// private methods
/**
* Sets the number of this section.
*
* @param number the number of this section
* @param numbers an <CODE>ArrayList</CODE>, containing the numbers of the Parent
*/
private void setNumbers(int number, ArrayList numbers) {
this.numbers = new ArrayList();
this.numbers.add(new Integer(number));
this.numbers.addAll(numbers);
}
// implementation of the Element-methods
/**
* Processes the element by adding it (or the different parts) to an
* <CODE>ElementListener</CODE>.
*
* @param listener the <CODE>ElementListener</CODE>
* @return <CODE>true</CODE> if the element was processed successfully
*/
public boolean process(ElementListener listener) {
try {
for (Iterator i = iterator(); i.hasNext(); ) {
listener.add((Element) i.next());
}
return true;
}
catch(DocumentException de) {
return false;
}
}
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return Element.SECTION;
}
/**
* Gets all the chunks in this element.
*
* @return an <CODE>ArrayList</CODE>
*/
public ArrayList getChunks() {
ArrayList tmp = new ArrayList();
for (Iterator i = iterator(); i.hasNext(); ) {
tmp.addAll(((Element) i.next()).getChunks());
}
return tmp;
}
// overriding some of the ArrayList-methods
/**
* Adds a <CODE>Paragraph</CODE>, <CODE>List</CODE> or <CODE>Table</CODE>
* to this <CODE>Section</CODE>.
*
* @param index index at which the specified element is to be inserted
* @param o an object of type <CODE>Paragraph</CODE>, <CODE>List</CODE> or <CODE>Table</CODE>=
* @throws ClassCastException if the object is not a <CODE>Paragraph</CODE>, <CODE>List</CODE> or <CODE>Table</CODE>
*/
public void add(int index, Object o) {
try {
Element element = (Element) o;
if (element.type() == Element.PARAGRAPH ||
element.type() == Element.LIST ||
element.type() == Element.CHUNK ||
element.type() == Element.PHRASE ||
element.type() == Element.ANCHOR ||
element.type() == Element.ANNOTATION ||
element.type() == Element.TABLE ||
element.type() == Element.PTABLE ||
element.type() == Element.IMGTEMPLATE ||
element.type() == Element.JPEG ||
element.type() == Element.IMGRAW) {
super.add(index, element);
}
else {
throw new ClassCastException(String.valueOf(element.type()));
}
}
catch(ClassCastException cce) {
throw new ClassCastException("Insertion of illegal Element: " + cce.getMessage());
}
}
/**
* Adds a <CODE>Paragraph</CODE>, <CODE>List</CODE>, <CODE>Table</CODE> or another <CODE>Section</CODE>
* to this <CODE>Section</CODE>.
*
* @param o an object of type <CODE>Paragraph</CODE>, <CODE>List</CODE>, <CODE>Table</CODE> or another <CODE>Section</CODE>
* @return a boolean
* @throws ClassCastException if the object is not a <CODE>Paragraph</CODE>, <CODE>List</CODE>, <CODE>Table</CODE> or <CODE>Section</CODE>
*/
public boolean add(Object o) {
try {
Element element = (Element) o;
if (element.type() == Element.PARAGRAPH ||
element.type() == Element.LIST ||
element.type() == Element.CHUNK ||
element.type() == Element.PHRASE ||
element.type() == Element.ANCHOR ||
element.type() == Element.ANNOTATION ||
element.type() == Element.TABLE ||
element.type() == Element.IMGTEMPLATE ||
element.type() == Element.PTABLE ||
element.type() == Element.JPEG ||
element.type() == Element.IMGRAW) {
return super.add(o);
}
else if (element.type() == Element.SECTION) {
Section section = (Section) o;
section.setNumbers(++subsections, numbers);
return super.add(section);
}
else {
throw new ClassCastException(String.valueOf(element.type()));
}
}
catch(ClassCastException cce) {
throw new ClassCastException("Insertion of illegal Element: " + cce.getMessage());
}
}
/**
* Adds a collection of <CODE>Element</CODE>s
* to this <CODE>Section</CODE>.
*
* @param collection a collection of <CODE>Paragraph</CODE>s, <CODE>List</CODE>s and/or <CODE>Table</CODE>s
* @return <CODE>true</CODE> if the action succeeded, <CODE>false</CODE> if not.
* @throws ClassCastException if one of the objects isn't a <CODE>Paragraph</CODE>, <CODE>List</CODE>, <CODE>Table</CODE>
*/
public boolean addAll(Collection collection) {
for (Iterator iterator = collection.iterator(); iterator.hasNext(); ) {
this.add(iterator.next());
}
return true;
}
// methods that return a Section
/**
* Creates a <CODE>Section</CODE>, adds it to this <CODE>Section</CODE> and returns it.
*
* @param indentation the indentation of the new section
* @param title the title of the new section
* @param numberDepth the numberDepth of the section
*/
public Section addSection(float indentation, Paragraph title, int numberDepth) {
Section section = new Section(title, numberDepth);
section.setIndentation(indentation);
add(section);
return section;
}
/**
* Creates a <CODE>Section</CODE>, adds it to this <CODE>Section</CODE> and returns it.
*
* @param indentation the indentation of the new section
* @param title the title of the new section
*/
public Section addSection(float indentation, Paragraph title) {
Section section = new Section(title, 1);
section.setIndentation(indentation);
add(section);
return section;
}
/**
* Creates a <CODE>Section</CODE>, add it to this <CODE>Section</CODE> and returns it.
*
* @param title the title of the new section
* @param numberDepth the numberDepth of the section
*/
public Section addSection(Paragraph title, int numberDepth) {
Section section = new Section(title, numberDepth);
add(section);
return section;
}
/**
* Creates a <CODE>Section</CODE>, adds it to this <CODE>Section</CODE> and returns it.
*
* @param title the title of the new section
*/
public Section addSection(Paragraph title) {
Section section = new Section(title, 1);
add(section);
return section;
}
/**
* Adds a <CODE>Section</CODE> to this <CODE>Section</CODE> and returns it.
*
* @param indentation the indentation of the new section
* @param title the title of the new section
* @param numberDepth the numberDepth of the section
*/
public Section addSection(float indentation, String title, int numberDepth) {
Section section = new Section(new Paragraph(title), numberDepth);
section.setIndentation(indentation);
add(section);
return section;
}
/**
* Adds a <CODE>Section</CODE> to this <CODE>Section</CODE> and returns it.
*
* @param title the title of the new section
* @param numberDepth the numberDepth of the section
*/
public Section addSection(String title, int numberDepth) {
Section section = new Section(new Paragraph(title), numberDepth);
add(section);
return section;
}
/**
* Adds a <CODE>Section</CODE> to this <CODE>Section</CODE> and returns it.
*
* @param indentation the indentation of the new section
* @param title the title of the new section
*/
public Section addSection(float indentation, String title) {
Section section = new Section(new Paragraph(title), 1);
section.setIndentation(indentation);
add(section);
return section;
}
/**
* Adds a <CODE>Section</CODE> to this <CODE>Section</CODE> and returns it.
*
* @param title the title of the new section
*/
public Section addSection(String title) {
Section section = new Section(new Paragraph(title), 1);
add(section);
return section;
}
/**
* Creates a given <CODE>Section</CODE> following a set of attributes and adds it to this one.
*
* @param attributes the attributes
* @return a Section
*/
public Section addSection(Properties attributes) {
Section section = new Section(new Paragraph(""), 1);
String value;
if ((value = (String)attributes.remove(ElementTags.NUMBER)) != null) {
subsections = Integer.parseInt(value) - 1;
}
section.set(attributes);
add(section);
return section;
}
// public methods
/**
* Alters the attributes of this <CODE>Section</CODE>.
*
* @param attributes the attributes
*/
public void set(Properties attributes) {
String value;
if ((value = (String)attributes.remove(ElementTags.NUMBERDEPTH)) != null) {
setNumberDepth(Integer.parseInt(value));
}
if ((value = (String)attributes.remove(ElementTags.INDENT)) != null) {
setIndentation(Float.valueOf(value + "f").floatValue());
}
if ((value = (String)attributes.remove(ElementTags.INDENTATIONLEFT)) != null) {
setIndentationLeft(Float.valueOf(value + "f").floatValue());
}
if ((value = (String)attributes.remove(ElementTags.INDENTATIONRIGHT)) != null) {
setIndentationRight(Float.valueOf(value + "f").floatValue());
}
}
/**
* Sets the title of this section.
*
* @param title the new title
*/
public void setTitle(Paragraph title) {
this.title = title;
}
/**
* Sets the depth of the sectionnumbers that will be shown preceding the title.
* <P>
* If the numberdepth is 0, the sections will not be numbered. If the numberdepth
* is 1, the section will be numbered with their own number. If the numberdepth is
* higher (for instance x > 1), the numbers of x - 1 parents will be shown.
*
* @param numberDepth the new numberDepth
*/
public void setNumberDepth(int numberDepth) {
this.numberDepth = numberDepth;
}
/**
* Sets the indentation of this <CODE>Section</CODE> on the left side.
*
* @param indentation the indentation
*/
public void setIndentationLeft(float indentation) {
indentationLeft = indentation;
}
/**
* Sets the indentation of this <CODE>Section</CODE> on the right side.
*
* @param indentation the indentation
*/
public void setIndentationRight(float indentation) {
indentationRight = indentation;
}
/**
* Sets the indentation of the content of this <CODE>Section</CODE>.
*
* @param indentation the indentation
*/
public void setIndentation(float indentation) {
sectionIndent = indentation;
}
// methods to retrieve information
/**
* Checks if this object is a <CODE>Chapter</CODE>.
*
* @return <CODE>true</CODE> if it is a <CODE>Chapter</CODE>,
* <CODE>false</CODE> if it is a <CODE>Section</CODE>.
*/
public boolean isChapter() {
return type() == Element.CHAPTER;
}
/**
* Checks if this object is a <CODE>Section</CODE>.
*
* @return <CODE>true</CODE> if it is a <CODE>Section</CODE>,
* <CODE>false</CODE> if it is a <CODE>Chapter</CODE>.
*/
public boolean isSection() {
return type() == Element.SECTION;
}
/**
* Returns the numberdepth of this <CODE>Section</CODE>.
*
* @return the numberdepth
*/
public int numberDepth() {
return numberDepth;
}
/**
* Returns the indentation of this <CODE>Section</CODE> on the left side.
*
* @return the indentation
*/
public float indentationLeft() {
return indentationLeft;
}
/**
* Returns the indentation of this <CODE>Section</CODE> on the right side.
*
* @return the indentation
*/
public float indentationRight() {
return indentationRight;
}
/**
* Returns the indentation of the content of this <CODE>Section</CODE>.
*
* @return the indentation
*/
public float indentation() {
return sectionIndent;
}
/**
* Returns the depth of this section.
*
* @return the depth
*/
public int depth() {
return numbers.size();
}
/**
* Returns the title, preceeded by a certain number of sectionnumbers.
*
* @return a <CODE>Paragraph</CODE>
*/
public Paragraph title() {
if (title == null) {
return null;
}
int depth = Math.min(numbers.size(), numberDepth);
if (depth < 1) {
return title;
}
StringBuffer buf = new StringBuffer(" ");
for (int i = 0; i < depth; i++) {
buf.insert(0, ".");
buf.insert(0, ((Integer) numbers.get(i)).intValue());
}
Paragraph result = new Paragraph(title);
result.setMarkupAttributes(title.getMarkupAttributes());
result.add(0, new Chunk(buf.toString(), title.font()));
return result;
}
/**
* Checks if a given tag corresponds with a title tag for this object.
*
* @param tag the given tag
* @return true if the tag corresponds
*/
public static boolean isTitle(String tag) {
return ElementTags.TITLE.equals(tag);
}
/**
* Checks if a given tag corresponds with this object.
*
* @param tag the given tag
* @return true if the tag corresponds
*/
public static boolean isTag(String tag) {
return ElementTags.SECTION.equals(tag);
}
/** Getter for property bookmarkOpen.
* @return Value of property bookmarkOpen.
*/
public boolean isBookmarkOpen() {
return bookmarkOpen;
}
/** Setter for property bookmarkOpen.
* @param bookmarkOpen false if the bookmark children are not
* visible.
*/
public void setBookmarkOpen(boolean bookmarkOpen) {
this.bookmarkOpen = bookmarkOpen;
}
}
|