From dea649d06b3bb7eb869a2a74a14a5072c7c20ec1 Mon Sep 17 00:00:00 2001
From: Yegor Kozlov
+ * If the border is on the left or right, no border is displayed.
+ *
+ *
+ * @author Gisella Bronzetti
+ */
+public enum Borders {
+
+ NIL(1),
+
+ NONE(2),
+
+ /**
+ * Specifies a line border consisting of a single line around the parent
+ * object.
+ */
+ SINGLE(3),
+
+ THICK(4),
+
+ DOUBLE(5),
+
+ DOTTED(6),
+
+ DASHED(7),
+
+ DOT_DASH(8),
+
+ DOT_DOT_DASH(9),
+
+ TRIPLE(10),
+
+ THIN_THICK_SMALL_GAP(11),
+
+ THICK_THIN_SMALL_GAP(12),
+
+ THIN_THICK_THIN_SMALL_GAP(13),
+
+ THIN_THICK_MEDIUM_GAP(14),
+
+ THICK_THIN_MEDIUM_GAP(15),
+
+ THIN_THICK_THIN_MEDIUM_GAP(16),
+
+ THIN_THICK_LARGE_GAP(17),
+
+ THICK_THIN_LARGE_GAP(18),
+
+ THIN_THICK_THIN_LARGE_GAP(19),
+
+ WAVE(20),
+
+ DOUBLE_WAVE(21),
+
+ DASH_SMALL_GAP(22),
+
+ DASH_DOT_STROKED(23),
+
+ THREE_D_EMBOSS(24),
+
+ THREE_D_ENGRAVE(25),
+
+ OUTSET(26),
+
+ INSET(27),
+
+ /**
+ * Specifies an art border consisting of a repeated image of an apple
+ */
+ APPLES(28),
+
+ /**
+ * Specifies an art border consisting of a repeated image of a shell pattern
+ */
+ ARCHED_SCALLOPS(29),
+
+ /**
+ * Specifies an art border consisting of a repeated image of a baby pacifier
+ */
+ BABY_PACIFIER(30),
+
+ /**
+ * Specifies an art border consisting of a repeated image of a baby rattle
+ */
+ BABY_RATTLE(31),
+
+ /**
+ * Specifies an art border consisting of a repeated image of a set of
+ * balloons
+ */
+ BALLOONS_3_COLORS(32),
+
+ /**
+ * Specifies an art border consisting of a repeated image of a hot air
+ * balloon
+ */
+ BALLOONS_HOT_AIR(33),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a black and
+ * white background.
+ */
+ BASIC_BLACK_DASHES(34),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a black dot on
+ * a white background.
+ */
+ BASIC_BLACK_DOTS(35),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a black and
+ * white background
+ */
+ BASIC_BLACK_SQUARES(36),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a black and
+ * white background.
+ */
+ BASIC_THIN_LINES(37),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a black and
+ * white background.
+ */
+ BASIC_WHITE_DASHES(38),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a white dot on
+ * a black background.
+ */
+ BASIC_WHITE_DOTS(39),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a black and
+ * white background.
+ */
+ BASIC_WHITE_SQUARES(40),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a black and
+ * white background.
+ */
+ BASIC_WIDE_INLINE(41),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a black and
+ * white background
+ */
+ BASIC_WIDE_MIDLINE(42),
+
+ /**
+ * Specifies an art border consisting of a repeating image of a black and
+ * white background
+ */
+ BASIC_WIDE_OUTLINE(43),
+
+ /**
+ * Specifies an art border consisting of a repeated image of bats
+ */
+ BATS(44),
+
+ /**
+ * Specifies an art border consisting of repeating images of birds
+ */
+ BIRDS(45),
+
+ /**
+ * Specifies an art border consisting of a repeated image of birds flying
+ */
+ BIRDS_FLIGHT(46),
+
+ /**
+ * Specifies an art border consisting of a repeated image of a cabin
+ */
+ CABINS(47),
+
+ /**
+ * Specifies an art border consisting of a repeated image of a piece of cake
+ */
+ CAKE_SLICE(48),
+
+ /**
+ * Specifies an art border consisting of a repeated image of candy corn
+ */
+ CANDY_CORN(49),
+
+ /**
+ * Specifies an art border consisting of a repeated image of a knot work
+ * pattern
+ */
+ CELTIC_KNOTWORK(50),
+
+ /**
+ * Specifies an art border consisting of a banner.
+ *
- * If this element is not set on a given paragraph, its value is determined by the setting previously - * set at any level of the style hierarchy (i.e. that previous setting remains unchanged). - * If this setting is never specified in the style hierarchy, then no alignment is applied to the paragraph. + * Specifies the paragraph alignment which shall be applied to text in this + * paragraph. + *
+ * + * If this element is not set on a given paragraph, its value is determined + * by the setting previously set at any level of the style hierarchy (i.e. + * that previous setting remains unchanged). If this setting is never + * specified in the style hierarchy, then no alignment is applied to the + * paragraph. * * * @param align the paragraph alignment to apply to this paragraph. */ - public void setAlignment(ParagraphAlignment align){ - CTPPr pr = paragraph.isSetPPr() ? paragraph.getPPr() : paragraph.addNewPPr(); + public void setAlignment(ParagraphAlignment align) { + CTPPr pr = paragraph.isSetPPr() ? paragraph.getPPr() : paragraph + .addNewPPr(); CTJc jc = pr.isSetJc() ? pr.getJc() : pr.addNewJc(); STJc.Enum en = STJc.Enum.forInt(align.getValue()); jc.setVal(en); } + /** + * Returns the text vertical alignment which shall be applied to text in + * this paragraph. + * + * If the line height (before any added spacing) is larger than one or more + * characters on the line, all characters will be aligned to each other as + * specified by this element. + * + * + * If this element is omitted on a given paragraph, its value is determined + * by the setting previously set at any level of the style hierarchy (i.e. + * that previous setting remains unchanged). If this setting is never + * specified in the style hierarchy, then the vertical alignment of all + * characters on the line shall be automatically determined by the consumer. + * + * + * @return the vertical alignment of this paragraph. + */ + public TextAlignment getVerticalAlignment() { + CTPPr pr = paragraph.getPPr(); + return pr == null || !pr.isSetTextAlignment() ? TextAlignment.AUTO + : TextAlignment.valueOf(pr.getTextAlignment().getVal() + .intValue()); + } + + /** + * Specifies the text vertical alignment which shall be applied to text in + * this paragraph. + * + * If the line height (before any added spacing) is larger than one or more + * characters on the line, all characters will be aligned to each other as + * specified by this element. + * + * + * If this element is omitted on a given paragraph, its value is determined + * by the setting previously set at any level of the style hierarchy (i.e. + * that previous setting remains unchanged). If this setting is never + * specified in the style hierarchy, then the vertical alignment of all + * characters on the line shall be automatically determined by the consumer. + * + * + * @param valign the paragraph vertical alignment to apply to this + * paragraph. + */ + public void setVerticalAlignment(TextAlignment valign) { + CTPPr pr = paragraph.isSetPPr() ? paragraph.getPPr() : paragraph + .addNewPPr(); + CTTextAlignment textAlignment = pr.isSetTextAlignment() ? pr + .getTextAlignment() : pr.addNewTextAlignment(); + STTextAlignment.Enum en = STTextAlignment.Enum + .forInt(valign.getValue()); + textAlignment.setVal(en); + } + + /** + * Specifies the border which shall be displayed above a set of paragraphs + * which have the same set of paragraph border settings. + * + * + * To determine if any two adjoining paragraphs shall have an individual top + * and bottom border or a between border, the set of borders on the two + * adjoining paragraphs are compared. If the border information on those two + * paragraphs is identical for all possible paragraphs borders, then the + * between border is displayed. Otherwise, the final paragraph shall use its + * bottom border and the following paragraph shall use its top border, + * respectively. If this border specifies a space attribute, that value + * determines the space above the text (ignoring any spacing above) which + * should be left before this border is drawn, specified in points. + * + * + * If this element is omitted on a given paragraph, its value is determined + * by the setting previously set at any level of the style hierarchy (i.e. + * that previous setting remains unchanged). If this setting is never + * specified in the style hierarchy, then no between border shall be applied + * above identical paragraphs. + * + * This border can only be a line border. + * + * @param border + * @see Borders for a list of all types of borders + */ + public void setBorderTop(Borders border) { + CTPBdr ct = getCTPBrd(true); + CTBorder pr = ct.isSetTop() ? ct.getTop() : ct.addNewTop(); + if (border.getValue() == Borders.NONE.getValue()) + ct.unsetTop(); + else + pr.setVal(STBorder.Enum.forInt(border.getValue())); + } + + /** + * Specifies the border which shall be displayed above a set of paragraphs + * which have the same set of paragraph border settings. + * + * @return paragraphBorder - the top border for the paragraph + * @see #setBorderTop(Borders) + * @see Borders a list of all types of borders + */ + public Borders getBorderTop() { + CTPBdr border = getCTPBrd(false); + CTBorder ct; + if (border != null) { + ct = border.getTop(); + STBorder.Enum ptrn = ct != null ? ct.getVal() : STBorder.NONE; + return Borders.valueOf(ptrn.intValue()); + } + return Borders.NONE; + } + + /** + * Specifies the border which shall be displayed below a set of paragraphs + * which have the same set of paragraph border settings. + * + * To determine if any two adjoining paragraphs shall have an individual top + * and bottom border or a between border, the set of borders on the two + * adjoining paragraphs are compared. If the border information on those two + * paragraphs is identical for all possible paragraphs borders, then the + * between border is displayed. Otherwise, the final paragraph shall use its + * bottom border and the following paragraph shall use its top border, + * respectively. If this border specifies a space attribute, that value + * determines the space after the bottom of the text (ignoring any space + * below) which should be left before this border is drawn, specified in + * points. + * + * + * If this element is omitted on a given paragraph, its value is determined + * by the setting previously set at any level of the style hierarchy (i.e. + * that previous setting remains unchanged). If this setting is never + * specified in the style hierarchy, then no between border shall be applied + * below identical paragraphs. + * + * This border can only be a line border. + * + * @param border + * @see Borders a list of all types of borders + */ + public void setBorderBottom(Borders border) { + CTPBdr ct = getCTPBrd(true); + CTBorder pr = ct.isSetBottom() ? ct.getBottom() : ct.addNewBottom(); + if (border.getValue() == Borders.NONE.getValue()) + ct.unsetBottom(); + else + pr.setVal(STBorder.Enum.forInt(border.getValue())); + } + + /** + * Specifies the border which shall be displayed below a set of + * paragraphs which have the same set of paragraph border settings. + * + * @return paragraphBorder - the bottom border for the paragraph + * @see #setBorderBottom(Borders) + * @see Borders a list of all types of borders + */ + public Borders getBorderBottom() { + CTPBdr border = getCTPBrd(false); + CTBorder ct = null; + if (border != null) { + ct = border.getBottom(); + } + STBorder.Enum ptrn = ct != null ? ct.getVal() : STBorder.NONE; + return Borders.valueOf(ptrn.intValue()); + } + + /** + * Specifies the border which shall be displayed on the left side of the + * page around the specified paragraph. + * + * To determine if any two adjoining paragraphs should have a left border + * which spans the full line height or not, the left border shall be drawn + * between the top border or between border at the top (whichever would be + * rendered for the current paragraph), and the bottom border or between + * border at the bottom (whichever would be rendered for the current + * paragraph). + * + * + * If this element is omitted on a given paragraph, its value is determined + * by the setting previously set at any level of the style hierarchy (i.e. + * that previous setting remains unchanged). If this setting is never + * specified in the style hierarchy, then no left border shall be applied. + * + * This border can only be a line border. + * + * @param border + * @see Borders for a list of all possible borders + */ + public void setBorderLeft(Borders border) { + CTPBdr ct = getCTPBrd(true); + CTBorder pr = ct.isSetLeft() ? ct.getLeft() : ct.addNewLeft(); + if (border.getValue() == Borders.NONE.getValue()) + ct.unsetLeft(); + else + pr.setVal(STBorder.Enum.forInt(border.getValue())); + } + + /** + * Specifies the border which shall be displayed on the left side of the + * page around the specified paragraph. + * + * @return ParagraphBorder - the left border for the paragraph + * @see #setBorderLeft(Borders) + * @see Borders for a list of all possible borders + */ + public Borders getBorderLeft() { + CTPBdr border = getCTPBrd(false); + CTBorder ct = null; + if (border != null) { + ct = border.getLeft(); + } + STBorder.Enum ptrn = ct != null ? ct.getVal() : STBorder.NONE; + return Borders.valueOf(ptrn.intValue()); + } + + /** + * Specifies the border which shall be displayed on the right side of the + * page around the specified paragraph. + * + * To determine if any two adjoining paragraphs should have a right border + * which spans the full line height or not, the right border shall be drawn + * between the top border or between border at the top (whichever would be + * rendered for the current paragraph), and the bottom border or between + * border at the bottom (whichever would be rendered for the current + * paragraph). + * + * + * If this element is omitted on a given paragraph, its value is determined + * by the setting previously set at any level of the style hierarchy (i.e. + * that previous setting remains unchanged). If this setting is never + * specified in the style hierarchy, then no right border shall be applied. + * + * This border can only be a line border. + * + * @param border + * @see Borders for a list of all possible borders + */ + public void setBorderRight(Borders border) { + CTPBdr ct = getCTPBrd(true); + CTBorder pr = ct.isSetRight() ? ct.getRight() : ct.addNewRight(); + if (border.getValue() == Borders.NONE.getValue()) + ct.unsetRight(); + else + pr.setVal(STBorder.Enum.forInt(border.getValue())); + } + + /** + * Specifies the border which shall be displayed on the right side of the + * page around the specified paragraph. + * + * @return ParagraphBorder - the right border for the paragraph + * @see #setBorderRight(Borders) + * @see Borders for a list of all possible borders + */ + public Borders getBorderRight() { + CTPBdr border = getCTPBrd(false); + CTBorder ct = null; + if (border != null) { + ct = border.getRight(); + } + STBorder.Enum ptrn = ct != null ? ct.getVal() : STBorder.NONE; + return Borders.valueOf(ptrn.intValue()); + } + + /** + * Specifies the border which shall be displayed between each paragraph in a + * set of paragraphs which have the same set of paragraph border settings. + * + * To determine if any two adjoining paragraphs should have a between border + * or an individual top and bottom border, the set of borders on the two + * adjoining paragraphs are compared. If the border information on those two + * paragraphs is identical for all possible paragraphs borders, then the + * between border is displayed. Otherwise, each paragraph shall use its + * bottom and top border, respectively. If this border specifies a space + * attribute, that value is ignored - this border is always located at the + * bottom of each paragraph with an identical following paragraph, taking + * into account any space after the line pitch. + * + * + * If this element is omitted on a given paragraph, its value is determined + * by the setting previously set at any level of the style hierarchy (i.e. + * that previous setting remains unchanged). If this setting is never + * specified in the style hierarchy, then no between border shall be applied + * between identical paragraphs. + * + * This border can only be a line border. + * + * @param border + * @see Borders for a list of all possible borders + */ + public void setBorderBetween(Borders border) { + CTPBdr ct = getCTPBrd(true); + CTBorder pr = ct.isSetBetween() ? ct.getBetween() : ct.addNewBetween(); + if (border.getValue() == Borders.NONE.getValue()) + ct.unsetBetween(); + else + pr.setVal(STBorder.Enum.forInt(border.getValue())); + } + + /** + * Specifies the border which shall be displayed between each paragraph in a + * set of paragraphs which have the same set of paragraph border settings. + * + * @return ParagraphBorder - the between border for the paragraph + * @see #setBorderBetween(Borders) + * @see Borders for a list of all possible borders + */ + public Borders getBorderBetween() { + CTPBdr border = getCTPBrd(false); + CTBorder ct = null; + if (border != null) { + ct = border.getBetween(); + } + STBorder.Enum ptrn = ct != null ? ct.getVal() : STBorder.NONE; + return Borders.valueOf(ptrn.intValue()); + } + + /** + * Specifies that when rendering this document in a paginated + * view, the contents of this paragraph are rendered on the start of a new + * page in the document. + * + * If this element is omitted on a given paragraph, + * its value is determined by the setting previously set at any level of the + * style hierarchy (i.e. that previous setting remains unchanged). If this + * setting is never specified in the style hierarchy, then this property + * shall not be applied. Since the paragraph is specified to start on a new + * page, it begins page two even though it could have fit on page one. + * + * + * @param pageBreak - + * boolean value + */ + public void setPageBreak(boolean pageBreak) { + CTPPr ppr = getCTPPr(); + CTOnOff ct_pageBreak = ppr.isSetPageBreakBefore() ? ppr + .getPageBreakBefore() : ppr.addNewPageBreakBefore(); + if (pageBreak) + ct_pageBreak.setVal(STOnOff.TRUE); + else + ct_pageBreak.setVal(STOnOff.FALSE); + } + + /** + * Specifies that when rendering this document in a paginated + * view, the contents of this paragraph are rendered on the start of a new + * page in the document. + * + * If this element is omitted on a given paragraph, + * its value is determined by the setting previously set at any level of the + * style hierarchy (i.e. that previous setting remains unchanged). If this + * setting is never specified in the style hierarchy, then this property + * shall not be applied. Since the paragraph is specified to start on a new + * page, it begins page two even though it could have fit on page one. + * + * + * @return boolean - if page break is set + */ + public boolean isPageBreak() { + CTPPr ppr = getCTPPr(); + CTOnOff ct_pageBreak = ppr.isSetPageBreakBefore() ? ppr + .getPageBreakBefore() : null; + if (ct_pageBreak != null + && ct_pageBreak.getVal().intValue() == STOnOff.INT_TRUE) + return true; + else + return false; + } + + /** + * Specifies the spacing that should be added after the last line in this + * paragraph in the document in absolute units. + * + * If the afterLines attribute or the afterAutoSpacing attribute is also + * specified, then this attribute value is ignored. + * + * + * @param spaces - + * a positive whole number, whose contents consist of a + * measurement in twentieths of a point. + */ + public void setSpacingAfter(BigInteger spaces) { + CTSpacing spacing = getCTSpacing(true); + if (spacing != null) + spacing.setAfter(spaces); + } + + /** + * Specifies the spacing that should be added after the last line in this + * paragraph in the document in absolute units. + * + * @return bigInteger - value representing the spacing after the paragraph + */ + public BigInteger getSpacingAfter() { + CTSpacing spacing = getCTSpacing(false); + return spacing.isSetAfter() ? spacing.getAfter() : null; + } + + /** + * Specifies the spacing that should be added after the last line in this + * paragraph in the document in line units. + * The value of this attribute is + * specified in one hundredths of a line. + * + * + * If the afterAutoSpacing attribute + * is also specified, then this attribute value is ignored. If this setting + * is never specified in the style hierarchy, then its value shall be zero + * (if needed) + * + * + * @param spaces - + * a positive whole number, whose contents consist of a + * measurement in twentieths of a + */ + public void setSpacingAfterLines(BigInteger spaces) { + CTSpacing spacing = getCTSpacing(true); + spacing.setAfterLines(spaces); + } + + + /** + * Specifies the spacing that should be added after the last line in this + * paragraph in the document in absolute units. + * + * @return bigInteger - value representing the spacing after the paragraph + * @see #setSpacingAfterLines(BigInteger) + */ + public BigInteger getSpacingAfterLines() { + CTSpacing spacing = getCTSpacing(false); + return spacing.isSetAfterLines() ? spacing.getAfterLines() : null; + } + + /** + * Specifies the spacing that should be added above the first line in this + * paragraph in the document in absolute units. + * + * If the beforeLines attribute or the beforeAutoSpacing attribute is also + * specified, then this attribute value is ignored. + * + * + * @param spaces + */ + public void setSpacingBefore(BigInteger spaces) { + CTSpacing spacing = getCTSpacing(true); + spacing.setBefore(spaces); + } + + /** + * Specifies the spacing that should be added above the first line in this + * paragraph in the document in absolute units. + * + * @return + * @see #setSpacingBefore(BigInteger) + */ + public BigInteger getSpacingBefore() { + CTSpacing spacing = getCTSpacing(false); + return spacing.isSetBefore() ? spacing.getBefore() : null; + } + + /** + * Specifies the spacing that should be added before the first line in this + * paragraph in the document in line units. The value of this attribute + * is specified in one hundredths of a line. + * + * If the beforeAutoSpacing attribute is also specified, then this attribute + * value is ignored. If this setting is never specified in the style + * hierarchy, then its value shall be zero. + * + * + * @param spaces + */ + public void setSpacingBeforeLines(BigInteger spaces) { + CTSpacing spacing = getCTSpacing(true); + spacing.setBeforeLines(spaces); + } + + /** + * Specifies the spacing that should be added before the first line in this paragraph in the + * document in line units. + * The value of this attribute is specified in one hundredths of a line. + * + * @return + * @see #setSpacingBeforeLines(BigInteger) + */ + public BigInteger getSpacingBeforeLines() { + CTSpacing spacing = getCTSpacing(false); + return spacing.isSetBeforeLines() ? spacing.getBeforeLines() : null; + } + + /** + * Specifies the indentation which shall be placed between the left text + * margin for this paragraph and the left edge of that paragraph's content + * in a left to right paragraph, and the right text margin and the right + * edge of that paragraph's text in a right to left paragraph + * + * If this attribute is omitted, its value shall be assumed to be zero. + * Negative values are defined such that the text is moved past the text margin, + * positive values move the text inside the text margin. + * + * + * @param indentation + */ + public void setIndentationLeft(BigInteger indentation) { + CTInd indent = getCTInd(true); + indent.setLeft(indentation); + } + + /** + * Specifies the indentation which shall be placed between the left text + * margin for this paragraph and the left edge of that paragraph's content + * in a left to right paragraph, and the right text margin and the right + * edge of that paragraph's text in a right to left paragraph + * + * If this attribute is omitted, its value shall be assumed to be zero. + * Negative values are defined such that the text is moved past the text margin, + * positive values move the text inside the text margin. + * + * + * @return indentation or null if indentation is not set + */ + public BigInteger getIndentationLeft() { + CTInd indentation = getCTInd(false); + return indentation.isSetLeft() ? indentation.getLeft() + : new BigInteger("0"); + } + + /** + * Specifies the indentation which shall be placed between the right text + * margin for this paragraph and the right edge of that paragraph's content + * in a left to right paragraph, and the right text margin and the right + * edge of that paragraph's text in a right to left paragraph + * + * If this attribute is omitted, its value shall be assumed to be zero. + * Negative values are defined such that the text is moved past the text margin, + * positive values move the text inside the text margin. + * + * + * @param indentation + */ + public void setIndentationRight(BigInteger indentation) { + CTInd indent = getCTInd(true); + indent.setRight(indentation); + } + + /** + * Specifies the indentation which shall be placed between the right text + * margin for this paragraph and the right edge of that paragraph's content + * in a left to right paragraph, and the right text margin and the right + * edge of that paragraph's text in a right to left paragraph + * + * If this attribute is omitted, its value shall be assumed to be zero. + * Negative values are defined such that the text is moved past the text margin, + * positive values move the text inside the text margin. + * + * + * @return indentation or null if indentation is not set + */ + + public BigInteger getIndentationRight() { + CTInd indentation = getCTInd(false); + return indentation.isSetRight() ? indentation.getRight() + : new BigInteger("0"); + } + + /** + * Specifies the indentation which shall be removed from the first line of + * the parent paragraph, by moving the indentation on the first line back + * towards the beginning of the direction of text flow. + * This indentation is specified relative to the paragraph indentation which is specified for + * all other lines in the parent paragraph. + * + * The firstLine and hanging attributes are mutually exclusive, if both are specified, then the + * firstLine value is ignored. + * + * + * @param indentation + */ + + public void setIndentationHanging(BigInteger indentation) { + CTInd indent = getCTInd(true); + indent.setHanging(indentation); + } + + /** + * Specifies the indentation which shall be removed from the first line of + * the parent paragraph, by moving the indentation on the first line back + * towards the beginning of the direction of text flow. + * This indentation is + * specified relative to the paragraph indentation which is specified for + * all other lines in the parent paragraph. + * The firstLine and hanging + * attributes are mutually exclusive, if both are specified, then the + * firstLine value is ignored. + * + * @return indentation or null if indentation is not set + */ + public BigInteger getIndentationHanging() { + CTInd indentation = getCTInd(false); + return indentation.isSetHanging() ? indentation.getHanging() : null; + } + + /** + * Specifies the additional indentation which shall be applied to the first + * line of the parent paragraph. This additional indentation is specified + * relative to the paragraph indentation which is specified for all other + * lines in the parent paragraph. + * The firstLine and hanging attributes are + * mutually exclusive, if both are specified, then the firstLine value is + * ignored. + * If the firstLineChars attribute is also specified, then this + * value is ignored. If this attribute is omitted, then its value shall be + * assumed to be zero (if needed). + * + * @param indentation + */ + public void setIndentationFirstLine(BigInteger indentation) { + CTInd indent = getCTInd(true); + indent.setFirstLine(indentation); + } + + /** + * Specifies the additional indentation which shall be applied to the first + * line of the parent paragraph. This additional indentation is specified + * relative to the paragraph indentation which is specified for all other + * lines in the parent paragraph. + * The firstLine and hanging attributes are + * mutually exclusive, if both are specified, then the firstLine value is + * ignored. + * If the firstLineChars attribute is also specified, then this + * value is ignored. + * If this attribute is omitted, then its value shall be + * assumed to be zero (if needed). + * + * @return indentation or null if indentation is not set + */ + public BigInteger getIndentationFirstLine() { + CTInd indentation = getCTInd(false); + return indentation.isSetFirstLine() ? indentation.getFirstLine() + : new BigInteger("0"); + } + + /** + * This element specifies whether a consumer shall break Latin text which + * exceeds the text extents of a line by breaking the word across two lines + * (breaking on the character level) or by moving the word to the following + * line (breaking on the word level). + * + * @param wrap - boolean + */ + public void setWordWrap(boolean wrap) { + CTOnOff wordWrap = getCTPPr().isSetWordWrap() ? getCTPPr() + .getWordWrap() : getCTPPr().addNewWordWrap(); + if (wrap) + wordWrap.setVal(STOnOff.TRUE); + else + wordWrap.unsetVal(); + } + + /** + * This element specifies whether a consumer shall break Latin text which + * exceeds the text extents of a line by breaking the word across two lines + * (breaking on the character level) or by moving the word to the following + * line (breaking on the word level). + * + * @return boolean + */ + public boolean isWordWrap() { + CTOnOff wordWrap = getCTPPr().isSetWordWrap() ? getCTPPr() + .getWordWrap() : null; + if (wordWrap != null) { + return (wordWrap.getVal() == STOnOff.ON + || wordWrap.getVal() == STOnOff.TRUE || wordWrap.getVal() == STOnOff.X_1) ? true + : false; + } else + return false; + } + + /** + * Get a copy of the currently used CTPBrd, if none is used, return + * a new instance. + */ + private CTPBdr getCTPBrd(boolean create) { + CTPPr pr = getCTPPr(); + if (pr != null) { + CTPBdr ct = pr.isSetPBdr() ? pr.getPBdr() : null; + if (create && ct == null) + ct = pr.addNewPBdr(); + return ct; + } + return null; + } + + /** + * Get a copy of the currently used CTSpacing, if none is used, + * return a new instance. + */ + private CTSpacing getCTSpacing(boolean create) { + CTPPr pr = getCTPPr(); + if (pr != null) { + CTSpacing ct = pr.isSetSpacing() ? pr.getSpacing() : null; + if (create && ct == null) + ct = pr.addNewSpacing(); + return ct; + } + return null; + } + + /** + * Get a copy of the currently used CTPInd, if none is used, return + * a new instance. + */ + private CTInd getCTInd(boolean create) { + CTPPr pr = getCTPPr(); + if (pr != null) { + CTInd ct = pr.isSetInd() ? pr.getInd() : null; + if (create && ct == null) + ct = pr.addNewInd(); + return ct; + } + return null; + } + + private CTPPr getCTPPr() { + CTPPr pr = paragraph.getPPr() == null ? paragraph.addNewPPr() + : paragraph.getPPr(); + return pr; + } + } diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java index 7af82bdbfc..8933b494cf 100755 --- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java +++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java @@ -307,7 +307,7 @@ public class XWPFRun { */ public BigInteger getFontSize() { CTRPr pr = run.getRPr(); - return (pr != null && pr.isSetSz()) ? pr.getSz().getVal() : null; + return (pr != null && pr.isSetSz()) ? pr.getSz().getVal().divide(new BigInteger("2")) : null; } /** @@ -325,7 +325,7 @@ public class XWPFRun { public void setFontSize(BigInteger size) { CTRPr pr = run.isSetRPr() ? run.getRPr() : run.addNewRPr(); CTHpsMeasure ctSize = pr.isSetSz() ? pr.getSz() : pr.addNewSz(); - ctSize.setVal(size); + ctSize.setVal(size.multiply(new BigInteger("2"))); } /** diff --git a/src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFParagraph.java b/src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFParagraph.java index 65fb7f3312..c43f3ebd1f 100644 --- a/src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFParagraph.java +++ b/src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFParagraph.java @@ -17,80 +17,181 @@ package org.apache.poi.xwpf.usermodel; import java.io.File; - -import org.apache.poi.POIXMLDocument; -import org.apache.poi.xwpf.usermodel.XWPFDocument; +import java.math.BigInteger; import junit.framework.TestCase; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBorder; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTJc; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTOnOff; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPBdr; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPPr; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSpacing; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTextAlignment; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.STBorder; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.STJc; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.STOnOff; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextAlignment; +import org.apache.poi.POIXMLDocument; + /** * Tests for XWPF Paragraphs */ public class TestXWPFParagraph extends TestCase { - /** - * A simple file - */ - private XWPFDocument xml; - private File file; - - protected void setUp() throws Exception { - super.setUp(); - - file = new File( - System.getProperty("HWPF.testdata.path") + - File.separator + "ThreeColHead.docx" - ); - assertTrue(file.exists()); - xml = new XWPFDocument(POIXMLDocument.openPackage(file.toString())); - } - - /** - * Check that we get the right paragraph from the header - */ - public void testHeaderParagraph() throws Exception { - XWPFHeader hdr = xml.getHeaderFooterPolicy().getDefaultHeader(); - assertNotNull(hdr); - - XWPFParagraph[] ps = hdr.getParagraphs(); - assertEquals(1, ps.length); - XWPFParagraph p = ps[0]; - - assertEquals(5, p.getCTP().getRArray().length); - assertEquals( - "First header column!\tMid header\tRight header!", - p.getText() - ); - } - - /** - * Check that we get the right paragraphs from the document - */ - public void testDocumentParagraph() throws Exception { - XWPFParagraph[] ps = xml.getParagraphs(); - assertEquals(10, ps.length); - - assertFalse(ps[0].isEmpty()); - assertEquals( - "This is a sample word document. It has two pages. It has a three column heading, but no footer.", - ps[0].getText() - ); - - assertTrue(ps[1].isEmpty()); - assertEquals("", ps[1].getText()); - - assertFalse(ps[2].isEmpty()); - assertEquals( - "HEADING TEXT", - ps[2].getText() - ); - - assertTrue(ps[3].isEmpty()); - assertEquals("", ps[3].getText()); - - assertFalse(ps[4].isEmpty()); - assertEquals( - "More on page one", - ps[4].getText() - ); - } + /** + * A simple file + */ + private XWPFDocument xml; + private File file; + + protected void setUp() throws Exception { + super.setUp(); + + file = new File( + System.getProperty("HWPF.testdata.path") + + File.separator + "ThreeColHead.docx" + ); + assertTrue(file.exists()); + xml = new XWPFDocument(POIXMLDocument.openPackage(file.toString())); + } + + /** + * Check that we get the right paragraph from the header + */ + public void testHeaderParagraph() throws Exception { + XWPFHeader hdr = xml.getHeaderFooterPolicy().getDefaultHeader(); + assertNotNull(hdr); + + XWPFParagraph[] ps = hdr.getParagraphs(); + assertEquals(1, ps.length); + XWPFParagraph p = ps[0]; + + assertEquals(5, p.getCTP().getRArray().length); + assertEquals("First header column!\tMid header\tRight header!", p + .getText()); + } + + /** + * Check that we get the right paragraphs from the document + */ + public void testDocumentParagraph() throws Exception { + XWPFParagraph[] ps = xml.getParagraphs(); + assertEquals(10, ps.length); + + assertFalse(ps[0].isEmpty()); + assertEquals( + "This is a sample word document. It has two pages. It has a three column heading, but no footer.", + ps[0].getText()); + + assertTrue(ps[1].isEmpty()); + assertEquals("", ps[1].getText()); + + assertFalse(ps[2].isEmpty()); + assertEquals("HEADING TEXT", ps[2].getText()); + + assertTrue(ps[3].isEmpty()); + assertEquals("", ps[3].getText()); + + assertFalse(ps[4].isEmpty()); + assertEquals("More on page one", ps[4].getText()); + } + + public void testSetGetBorderTop() { + //new clean instance of paragraph + XWPFDocument doc = new XWPFDocument(); + XWPFParagraph p = doc.createParagraph(); + + CTP ctp = p.getCTP(); + CTPPr ppr = ctp.addNewPPr(); + //bordi + CTPBdr bdr = ppr.addNewPBdr(); + CTBorder borderTop = bdr.addNewTop(); + borderTop.setVal(STBorder.APPLES); + bdr.setTop(borderTop); + assertEquals(Borders.APPLES, p.getBorderTop()); + p.setBorderTop(Borders.SINGLE); + assertEquals(STBorder.SINGLE, borderTop.getVal()); + } + + public void testSetGetAlignment() { + //new clean instance of paragraph + XWPFDocument doc = new XWPFDocument(); + XWPFParagraph p = doc.createParagraph(); + + CTP ctp = p.getCTP(); + CTPPr ppr = ctp.addNewPPr(); + + CTJc align = ppr.addNewJc(); + align.setVal(STJc.CENTER); + assertEquals(ParagraphAlignment.CENTER, p.getAlignment()); + + p.setAlignment(ParagraphAlignment.BOTH); + assertEquals(STJc.BOTH, ppr.getJc().getVal()); + } + + public void testSetGetSpacing() { + XWPFDocument doc = new XWPFDocument(); + XWPFParagraph p = doc.createParagraph(); + + CTP ctp = p.getCTP(); + CTPPr ppr = ctp.addNewPPr(); + + //TEST ALL OTHERS POSSIBLE COMBINATIONS + CTSpacing spacing = ppr.addNewSpacing(); + spacing.setAfter(new BigInteger("10")); + assertEquals(10, p.getSpacingAfter().longValue()); + + p.setSpacingAfter(new BigInteger("100")); + assertEquals(100, spacing.getAfter().longValue()); + } + + public void testSetGetVerticalAlignment() { + //new clean instance of paragraph + XWPFDocument doc = new XWPFDocument(); + XWPFParagraph p = doc.createParagraph(); + + CTP ctp = p.getCTP(); + CTPPr ppr = ctp.addNewPPr(); + + CTTextAlignment txtAlign = ppr.addNewTextAlignment(); + txtAlign.setVal(STTextAlignment.CENTER); + assertEquals(TextAlignment.CENTER, p.getVerticalAlignment()); + + p.setVerticalAlignment(TextAlignment.BOTTOM); + assertEquals(STTextAlignment.BOTTOM, ppr.getTextAlignment().getVal()); + } + + public void testSetGetWordWrap() { + XWPFDocument doc = new XWPFDocument(); + XWPFParagraph p = doc.createParagraph(); + + CTP ctp = p.getCTP(); + CTPPr ppr = ctp.addNewPPr(); + + CTOnOff wordWrap = ppr.addNewWordWrap(); + wordWrap.setVal(STOnOff.FALSE); + assertEquals(false, p.isWordWrap()); + + p.setWordWrap(true); + assertEquals(STOnOff.TRUE, ppr.getWordWrap().getVal()); + } + + + public void testSetGetPageBreak() { + XWPFDocument doc = new XWPFDocument(); + XWPFParagraph p = doc.createParagraph(); + + CTP ctp = p.getCTP(); + CTPPr ppr = ctp.addNewPPr(); + + CTOnOff pageBreak = ppr.addNewPageBreakBefore(); + pageBreak.setVal(STOnOff.FALSE); + assertEquals(false, p.isPageBreak()); + + p.setPageBreak(true); + assertEquals(STOnOff.TRUE, ppr.getPageBreakBefore().getVal()); + } + + } diff --git a/src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFRun.java b/src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFRun.java index abe3a613c4..8f8c604126 100755 --- a/src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFRun.java +++ b/src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFRun.java @@ -35,101 +35,106 @@ public class TestXWPFRun extends TestCase { public XWPFParagraph p; protected void setUp() { - XWPFDocument doc = new XWPFDocument(); - p = doc.createParagraph(); + XWPFDocument doc = new XWPFDocument(); + p = doc.createParagraph(); - this.ctRun = CTR.Factory.newInstance(); + this.ctRun = CTR.Factory.newInstance(); } public void testSetGetBold() { - CTRPr rpr = ctRun.addNewRPr(); - rpr.addNewB().setVal(STOnOff.TRUE); + CTRPr rpr = ctRun.addNewRPr(); + rpr.addNewB().setVal(STOnOff.TRUE); - XWPFRun run = new XWPFRun(ctRun, p); - assertEquals(true, run.isBold()); + XWPFRun run = new XWPFRun(ctRun, p); + assertEquals(true, run.isBold()); - run.setBold(false); - assertEquals(STOnOff.FALSE, rpr.getB().getVal()); + run.setBold(false); + assertEquals(STOnOff.FALSE, rpr.getB().getVal()); } public void testSetGetItalic() { - CTRPr rpr = ctRun.addNewRPr(); - rpr.addNewI().setVal(STOnOff.TRUE); + CTRPr rpr = ctRun.addNewRPr(); + rpr.addNewI().setVal(STOnOff.TRUE); - XWPFRun run = new XWPFRun(ctRun, p); - assertEquals(true, run.isItalic()); + XWPFRun run = new XWPFRun(ctRun, p); + assertEquals(true, run.isItalic()); - run.setItalic(false); - assertEquals(STOnOff.FALSE, rpr.getI().getVal()); + run.setItalic(false); + assertEquals(STOnOff.FALSE, rpr.getI().getVal()); } public void testSetGetStrike() { - CTRPr rpr = ctRun.addNewRPr(); - rpr.addNewStrike().setVal(STOnOff.TRUE); + CTRPr rpr = ctRun.addNewRPr(); + rpr.addNewStrike().setVal(STOnOff.TRUE); - XWPFRun run = new XWPFRun(ctRun, p); - assertEquals(true, run.isStrike()); + XWPFRun run = new XWPFRun(ctRun, p); + assertEquals(true, run.isStrike()); - run.setStrike(false); - assertEquals(STOnOff.FALSE, rpr.getStrike().getVal()); + run.setStrike(false); + assertEquals(STOnOff.FALSE, rpr.getStrike().getVal()); } public void testSetGetUnderline() { - CTRPr rpr = ctRun.addNewRPr(); - rpr.addNewU().setVal(STUnderline.DASH); + CTRPr rpr = ctRun.addNewRPr(); + rpr.addNewU().setVal(STUnderline.DASH); - XWPFRun run = new XWPFRun(ctRun, p); - assertEquals(UnderlinePatterns.DASH.getValue(), run.getUnderline() - .getValue()); + XWPFRun run = new XWPFRun(ctRun, p); + assertEquals(UnderlinePatterns.DASH.getValue(), run.getUnderline() + .getValue()); - run.setUnderline(UnderlinePatterns.NONE); - assertEquals(STUnderline.NONE.intValue(), rpr.getU().getVal() - .intValue()); + run.setUnderline(UnderlinePatterns.NONE); + assertEquals(STUnderline.NONE.intValue(), rpr.getU().getVal() + .intValue()); } + public void testSetGetVAlign() { - CTRPr rpr = ctRun.addNewRPr(); - rpr.addNewVertAlign().setVal(STVerticalAlignRun.SUBSCRIPT); + CTRPr rpr = ctRun.addNewRPr(); + rpr.addNewVertAlign().setVal(STVerticalAlignRun.SUBSCRIPT); - XWPFRun run = new XWPFRun(ctRun, p); - assertEquals(VerticalAlign.SUBSCRIPT, run.getSubscript()); + XWPFRun run = new XWPFRun(ctRun, p); + assertEquals(VerticalAlign.SUBSCRIPT, run.getSubscript()); - run.setSubscript(VerticalAlign.BASELINE); - assertEquals(STVerticalAlignRun.BASELINE, rpr.getVertAlign().getVal()); + run.setSubscript(VerticalAlign.BASELINE); + assertEquals(STVerticalAlignRun.BASELINE, rpr.getVertAlign().getVal()); } + public void testSetGetFontFamily() { - CTRPr rpr = ctRun.addNewRPr(); - rpr.addNewRFonts().setAscii("Times New Roman"); + CTRPr rpr = ctRun.addNewRPr(); + rpr.addNewRFonts().setAscii("Times New Roman"); - XWPFRun run = new XWPFRun(ctRun, p); - assertEquals("Times New Roman", run.getFontFamily()); + XWPFRun run = new XWPFRun(ctRun, p); + assertEquals("Times New Roman", run.getFontFamily()); - run.setFontFamily("Verdana"); - assertEquals("Verdana", rpr.getRFonts().getAscii()); + run.setFontFamily("Verdana"); + assertEquals("Verdana", rpr.getRFonts().getAscii()); } + public void testSetGetFontSize() { - CTRPr rpr = ctRun.addNewRPr(); - rpr.addNewSz().setVal(new BigInteger("4000")); + CTRPr rpr = ctRun.addNewRPr(); + rpr.addNewSz().setVal(new BigInteger("14")); - XWPFRun run = new XWPFRun(ctRun, p); - assertEquals(4000, run.getFontSize().longValue()); + XWPFRun run = new XWPFRun(ctRun, p); + assertEquals(7, run.getFontSize().longValue()); - run.setFontSize(new BigInteger("2400")); - assertEquals(2400, rpr.getSz().getVal().longValue()); + run.setFontSize(new BigInteger("24")); + assertEquals(48, rpr.getSz().getVal().longValue()); } + public void testSetGetTextForegroundBackground() { - CTRPr rpr = ctRun.addNewRPr(); - rpr.addNewPosition().setVal(new BigInteger("4000")); + CTRPr rpr = ctRun.addNewRPr(); + rpr.addNewPosition().setVal(new BigInteger("4000")); - XWPFRun run = new XWPFRun(ctRun, p); - assertEquals(4000, run.getTextPosition().longValue()); + XWPFRun run = new XWPFRun(ctRun, p); + assertEquals(4000, run.getTextPosition().longValue()); - run.setTextPosition(new BigInteger("2400")); - assertEquals(2400, rpr.getPosition().getVal().longValue()); + run.setTextPosition(new BigInteger("2400")); + assertEquals(2400, rpr.getPosition().getVal().longValue()); } } + -- cgit v1.2.3