DropCapPosition

Inheritance: java.lang.Object

public class DropCapPosition

Specifies the position for a drop cap text.

Examples:

Shows how to create a drop cap.

 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert one paragraph with a large letter that the text in the second and third paragraphs begins with.
 builder.getFont().setSize(54.0);
 builder.writeln("L");

 builder.getFont().setSize(18.0);
 builder.writeln("orem ipsum dolor sit amet, consectetur adipiscing elit, " +
         "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ");
 builder.writeln("Ut enim ad minim veniam, quis nostrud exercitation " +
         "ullamco laboris nisi ut aliquip ex ea commodo consequat.");

 // Currently, the second and third paragraphs will appear underneath the first.
 // We can convert the first paragraph as a drop cap for the other paragraphs via its "ParagraphFormat" object.
 // Set the "DropCapPosition" property to "DropCapPosition.Margin" to place the drop cap
 // outside the left-hand side page margin if our text is left-to-right.
 // Set the "DropCapPosition" property to "DropCapPosition.Normal" to place the drop cap within the page margins
 // and to wrap the rest of the text around it.
 // "DropCapPosition.None" is the default state for all paragraphs.
 ParagraphFormat format = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat();
 format.setDropCapPosition(dropCapPosition);

 doc.save(getArtifactsDir() + "ParagraphFormat.DropCap.docx");
 

Fields

Field	Description
MARGIN	The drop cap is positioned outside the text margin on the anchor paragraph.
NONE	The paragraph does not have a drop cap.
NORMAL	The drop cap is positioned inside the text margin on the anchor paragraph.
length

Methods

Method	Description
fromName(String dropCapPositionName)
getName(int dropCapPosition)
getValues()
toString(int dropCapPosition)

MARGIN

public static int MARGIN

The drop cap is positioned outside the text margin on the anchor paragraph.

NONE

public static int NONE

The paragraph does not have a drop cap.

NORMAL

public static int NORMAL

The drop cap is positioned inside the text margin on the anchor paragraph.

length

public static int length

fromName(String dropCapPositionName)

public static int fromName(String dropCapPositionName)

Parameters:

Parameter	Type	Description
dropCapPositionName	java.lang.String

Returns: int

getName(int dropCapPosition)

public static String getName(int dropCapPosition)

Parameters:

Parameter	Type	Description
dropCapPosition	int

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int dropCapPosition)

public static String toString(int dropCapPosition)

Parameters:

Parameter	Type	Description
dropCapPosition	int

Returns: java.lang.String