/**\r
* This class handles color transformations\r
* \r
- * @see HSL code taken from <a href="https://tips4java.wordpress.com/2009/07/05/hsl-color/">Java Tips Weblog</a>\r
+ * @see <a href="https://tips4java.wordpress.com/2009/07/05/hsl-color/">HSL code taken from Java Tips Weblog</a>\r
*/\r
public class DrawPaint {\r
// HSL code is public domain - see https://tips4java.wordpress.com/contact-us/\r
* Apply lumMod / lumOff adjustments\r
*\r
* @param c the color to modify\r
- * @param lumMod luminance modulation in the range [0..100000]\r
- * @param lumOff luminance offset in the range [0..100000]\r
+ * @param fc the color style containing the lumMod / lumOff adjustments\r
* @return modified color\r
* \r
* @see <a href="https://msdn.microsoft.com/en-us/library/dd560821%28v=office.12%29.aspx">Using Office Open XML to Customize Document Formatting in the 2007 Office System</a>\r
* Gets the coordinate space of this group. All children are constrained
* to these coordinates.
*
- * @param anchor the coordinate space of this group
+ * @return the coordinate space of this group
*/
Rectangle2D getInteriorAnchor();
* (optional operation). If this sheet does not contain the element,
* it is unchanged.
*
- * @param xShape shape to be removed from this sheet, if present
+ * @param shape the shape to be removed from this sheet, if present
* @return <tt>true</tt> if this sheet contained the specified element
* @throws IllegalArgumentException if the type of the specified shape
* is incompatible with this sheet (optional)
* paragraph.setLineSpacing(-48.0);\r
* </code></pre>\r
* \r
- * @param linespacing the vertical line spacing\r
+ * @param lineSpacing the vertical line spacing\r
*/\r
void setLineSpacing(Double lineSpacing);\r
\r
* properties. This method is the generalized form of selecting and casting those\r
* properties.\r
*\r
- * @param resultClass\r
- * @param xquery\r
- * @return\r
+ * @param resultClass the requested result class\r
+ * @param xquery the simple (xmlbean) xpath expression to the property\r
+ * @return the xml object at the xpath location, or null if not found\r
*/\r
@SuppressWarnings("unchecked")\r
protected <T extends XmlObject> T selectProperty(Class<T> resultClass, String xquery) {\r
* Convert shape fill into java.awt.Paint. The result is either Color or\r
* TexturePaint or GradientPaint or null\r
*\r
- * @param graphics the target graphics\r
* @param obj the xml to read. Must contain elements from the EG_ColorChoice group:\r
* <code>\r
* a:scrgbClr RGB Color Model - Percentage Variant\r
* Returns the alignment that is applied to the paragraph.\r
*\r
* If this attribute is omitted, then null is returned.\r
- * User code can imply the value {@link TextAlign#LEFT} then.\r
+ * User code can imply the value {@link org.apache.poi.sl.usermodel.TextParagraph.TextAlign#LEFT} then.\r
*\r
* @return alignment that is applied to the paragraph\r
*/\r
/**\r
* Specifies the alignment that is to be applied to the paragraph.\r
* Possible values for this include left, right, centered, justified and distributed,\r
- * see {@link org.apache.poi.sl.usermodel.TextAlign}.\r
+ * see {@link org.apache.poi.sl.usermodel.TextParagraph.TextAlign}.\r
*\r
* @param align text align\r
*/\r
*\r
* @param data the data stream\r
* @param offset the offset within the data\r
- * @return the new offset\r
*/\r
public void parseProperty(byte data[], int offset) {\r
int count = LittleEndian.getUShort(data, offset);\r
public int getIndex() { return index; }
/**
- * @param id 0-based index of the text run in the SLWT container
+ * @param index 0-based index of the text run in the SLWT container
*/
public void setIndex(int index) { this.index = index; }
/**
* Return type of the shape.
- * In most cases shape group type is {@link org.apache.poi.hslf.model.ShapeTypes#NotPrimitive}
+ * In most cases shape group type is {@link org.apache.poi.sl.usermodel.ShapeType#NOT_PRIMITIVE}
*
* @return type of the shape.
*/
}
}
- /**
- * The anchor specified by {@link #getLogicalAnchor2D()} is the displayed size,
- * i.e. the size of the already clipped image
- */
+
@Override
public Insets getClipping() {
+ // The anchor specified by the escher properties is the displayed size,
+ // i.e. the size of the already clipped image
EscherOptRecord opt = getEscherOptRecord();
double top = getFractProp(opt, EscherProperties.BLIP__CROPFROMTOP);
* POIFS Filesystem. Parses the document and places all the
* important stuff into data structures.
*
- * @deprecated Use {@link #HSLFSlideShow(DirectoryNode)} instead
+ * @deprecated Use {@link #HSLFSlideShowImpl(DirectoryNode)} instead
* @param dir the POIFS directory to read from
* @param filesystem the POIFS FileSystem to read from
* @throws IOException if there is a problem while parsing the document.
/**
* Create a TableCell object and initialize it from the supplied Record container.
*
- * @param escherRecord {@link EscherSpContainer} container which holds information about this shape
+ * @param escherRecord EscherSpContainer which holds information about this shape
* @param parent the parent of the shape
*/
protected HSLFTableCell(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape> parent){
/**
* Create a new wrapper around a rich text string
- * @param parent The parent paragraph
+ * @param parentParagraph the parent paragraph
*/
public HSLFTextRun(HSLFTextParagraph parentParagraph) {
this.parentParagraph = parentParagraph;
projects / poi.git / commitdiff