Package com.itextpdf.layout.properties

Class Property

java.lang.Object

com.itextpdf.layout.properties.Property

 public final class Property extends Object 
      

An enum of property names that are used for graphical properties of layout elements. The IPropertyContainer performs the same function as an Map, with the values of Property as its potential keys.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACTION
static final int	ALIGN_CONTENT
static final int	ALIGN_ITEMS
static final int	ALIGN_SELF
static final int	APPEARANCE_STREAM_LAYOUT
static final int	AREA_BREAK_TYPE
static final int	AUTO_SCALE
static final int	AUTO_SCALE_HEIGHT
static final int	AUTO_SCALE_WIDTH
static final int	BACKGROUND
static final int	BACKGROUND_IMAGE
static final int	BASE_DIRECTION
static final int	BOLD_SIMULATION
static final int	BORDER
static final int	BORDER_BOTTOM
static final int	BORDER_BOTTOM_LEFT_RADIUS
static final int	BORDER_BOTTOM_RIGHT_RADIUS
static final int	BORDER_COLLAPSE
static final int	BORDER_LEFT
static final int	BORDER_RADIUS
static final int	BORDER_RIGHT
static final int	BORDER_TOP
static final int	BORDER_TOP_LEFT_RADIUS
static final int	BORDER_TOP_RIGHT_RADIUS
static final int	BOTTOM
static final int	BOX_SIZING
static final int	CAPTION_SIDE
static final int	CHARACTER_SPACING
static final int	CLEAR
static final int	COLLAPSING_MARGINS
static final int	COLSPAN
static final int	DESTINATION
static final int	FILL_AVAILABLE_AREA
static final int	FILL_AVAILABLE_AREA_ON_SPLIT
static final int	FIRST_LINE_INDENT
static final int	FLEX_BASIS
static final int	FLEX_GROW
static final int	FLEX_SHRINK
static final int	FLEX_WRAP
static final int	FLOAT
static final int	FLUSH_ON_DRAW
static final int	FONT	Font family as String or PdfFont shall be set.
static final int	FONT_COLOR
static final int	FONT_KERNING
static final int	FONT_PROVIDER	Shall be instance of FontProvider
static final int	FONT_SCRIPT
static final int	FONT_SET	Shall be instance of FontSet.
static final int	FONT_SIZE
static final int	FONT_STYLE	String value.
static final int	FONT_WEIGHT	String value.
static final int	FORCED_PLACEMENT
static final int	FULL
static final int	HEIGHT
static final int	HORIZONTAL_ALIGNMENT
static final int	HORIZONTAL_BORDER_SPACING
static final int	HORIZONTAL_SCALING	Value of 1 is equivalent to no scaling
static final int	HYPHENATION
static final int	ID
static final int	IGNORE_FOOTER
static final int	IGNORE_HEADER
static final int	INLINE_VERTICAL_ALIGNMENT
static final int	ITALIC_SIMULATION
static final int	JUSTIFY_CONTENT
static final int	KEEP_TOGETHER
static final int	KEEP_WITH_NEXT
static final int	LEADING
static final int	LEFT
static final int	LINE_DRAWER
static final int	LINE_HEIGHT
static final int	LINK_ANNOTATION
static final int	LIST_START
static final int	LIST_SYMBOL
static final int	LIST_SYMBOL_ALIGNMENT
static final int	LIST_SYMBOL_INDENT
static final int	LIST_SYMBOL_ORDINAL_VALUE
static final int	LIST_SYMBOL_POSITION
static final int	LIST_SYMBOL_POST_TEXT
static final int	LIST_SYMBOL_PRE_TEXT
static final int	LIST_SYMBOLS_INITIALIZED
static final int	MARGIN_BOTTOM
static final int	MARGIN_LEFT
static final int	MARGIN_RIGHT
static final int	MARGIN_TOP
static final int	MAX_HEIGHT
static final int	MAX_WIDTH
static final int	META_INFO
static final int	MIN_HEIGHT
static final int	MIN_WIDTH
static final int	NO_SOFT_WRAP_INLINE
static final int	OBJECT_FIT
static final int	OPACITY
static final int	ORPHANS_CONTROL
static final int	OUTLINE
static final int	OUTLINE_OFFSET
static final int	OVERFLOW_WRAP
static final int	OVERFLOW_X
static final int	OVERFLOW_Y
static final int	PADDING_BOTTOM
static final int	PADDING_LEFT
static final int	PADDING_RIGHT
static final int	PADDING_TOP
static final int	PAGE_NUMBER
static final int	POSITION
static final int	RENDERING_MODE
static final int	RIGHT
static final int	ROTATION_ANGLE
static final int	ROTATION_INITIAL_HEIGHT
static final int	ROTATION_INITIAL_WIDTH
static final int	ROTATION_POINT_X
static final int	ROTATION_POINT_Y
static final int	ROWSPAN
static final int	SKEW
static final int	SPACING_RATIO
static final int	SPLIT_CHARACTERS
static final int	STROKE_COLOR
static final int	STROKE_WIDTH
static final int	TAB_ANCHOR
static final int	TAB_DEFAULT
static final int	TAB_LEADER
static final int	TAB_STOPS
static final int	TABLE_LAYOUT
static final int	TAGGING_HELPER
static final int	TAGGING_HINT_KEY
static final int	TEXT_ALIGNMENT
static final int	TEXT_RENDERING_MODE	Use values from PdfCanvasConstants.TextRenderingMode.
static final int	TEXT_RISE
static final int	TOP
static final int	TRANSFORM
static final int	TYPOGRAPHY_CONFIG
static final int	UNDERLINE
static final int	VERTICAL_ALIGNMENT
static final int	VERTICAL_BORDER_SPACING
static final int	VERTICAL_SCALING	Value of 1 is equivalent to no scaling
static final int	WIDOWS_CONTROL
static final int	WIDTH
static final int	WORD_SPACING

Method Summary

Modifier and Type	Method	Description
static boolean	isPropertyInherited(int property)	This method checks whether a Property, in order to be picked up by the rendering engine, must be defined on the current element or renderer (return false), or may be defined in one of its parent elements or renderers (return true).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ACTION

 public static final int ACTION 
            

See Also:

• Constant Field Values

ALIGN_CONTENT

 public static final int ALIGN_CONTENT 
            

See Also:

• Constant Field Values

ALIGN_ITEMS

 public static final int ALIGN_ITEMS 
            

See Also:

• Constant Field Values

ALIGN_SELF

 public static final int ALIGN_SELF 
            

See Also:

• Constant Field Values

APPEARANCE_STREAM_LAYOUT

 public static final int APPEARANCE_STREAM_LAYOUT 
            

See Also:

• Constant Field Values

AREA_BREAK_TYPE

 public static final int AREA_BREAK_TYPE 
            

See Also:

• Constant Field Values

AUTO_SCALE

 public static final int AUTO_SCALE 
            

See Also:

• Constant Field Values

AUTO_SCALE_HEIGHT

 public static final int AUTO_SCALE_HEIGHT 
            

See Also:

• Constant Field Values

AUTO_SCALE_WIDTH

 public static final int AUTO_SCALE_WIDTH 
            

See Also:

• Constant Field Values

BACKGROUND

 public static final int BACKGROUND 
            

See Also:

• Constant Field Values

BACKGROUND_IMAGE

 public static final int BACKGROUND_IMAGE 
            

See Also:

• Constant Field Values

BASE_DIRECTION

 public static final int BASE_DIRECTION 
            

See Also:

• Constant Field Values

BOLD_SIMULATION

 public static final int BOLD_SIMULATION 
            

See Also:

• Constant Field Values

BORDER

 public static final int BORDER 
            

See Also:

• Constant Field Values

BORDER_BOTTOM

 public static final int BORDER_BOTTOM 
            

See Also:

• Constant Field Values

BORDER_BOTTOM_LEFT_RADIUS

 public static final int BORDER_BOTTOM_LEFT_RADIUS 
            

See Also:

• Constant Field Values

BORDER_BOTTOM_RIGHT_RADIUS

 public static final int BORDER_BOTTOM_RIGHT_RADIUS 
            

See Also:

• Constant Field Values

BORDER_COLLAPSE

 public static final int BORDER_COLLAPSE 
            

See Also:

• Constant Field Values

BORDER_LEFT

 public static final int BORDER_LEFT 
            

See Also:

• Constant Field Values

BORDER_RADIUS

 public static final int BORDER_RADIUS 
            

See Also:

• Constant Field Values

BORDER_RIGHT

 public static final int BORDER_RIGHT 
            

See Also:

• Constant Field Values

BORDER_TOP

 public static final int BORDER_TOP 
            

See Also:

• Constant Field Values

BORDER_TOP_LEFT_RADIUS

 public static final int BORDER_TOP_LEFT_RADIUS 
            

See Also:

• Constant Field Values

BORDER_TOP_RIGHT_RADIUS

 public static final int BORDER_TOP_RIGHT_RADIUS 
            

See Also:

• Constant Field Values

BOTTOM

 public static final int BOTTOM 
            

See Also:

• Constant Field Values

BOX_SIZING

 public static final int BOX_SIZING 
            

See Also:

• Constant Field Values

CAPTION_SIDE

 public static final int CAPTION_SIDE 
            

See Also:

• Constant Field Values

CHARACTER_SPACING

 public static final int CHARACTER_SPACING 
            

See Also:

• Constant Field Values

CLEAR

 public static final int CLEAR 
            

See Also:

• Constant Field Values

COLLAPSING_MARGINS

 public static final int COLLAPSING_MARGINS 
            

See Also:

• Constant Field Values

COLSPAN

 public static final int COLSPAN 
            

See Also:

• Constant Field Values

DESTINATION

 public static final int DESTINATION 
            

See Also:

• Constant Field Values

FILL_AVAILABLE_AREA

 public static final int FILL_AVAILABLE_AREA 
            

See Also:

• Constant Field Values

FILL_AVAILABLE_AREA_ON_SPLIT

 public static final int FILL_AVAILABLE_AREA_ON_SPLIT 
            

See Also:

• Constant Field Values

FIRST_LINE_INDENT

 public static final int FIRST_LINE_INDENT 
            

See Also:

• Constant Field Values

FLEX_BASIS

 public static final int FLEX_BASIS 
            

See Also:

• Constant Field Values

FLEX_GROW

 public static final int FLEX_GROW 
            

See Also:

• Constant Field Values

FLEX_SHRINK

 public static final int FLEX_SHRINK 
            

See Also:

• Constant Field Values

FLEX_WRAP

 public static final int FLEX_WRAP 
            

See Also:

• Constant Field Values

FLOAT

 public static final int FLOAT 
            

See Also:

• Constant Field Values

FLUSH_ON_DRAW

 public static final int FLUSH_ON_DRAW 
            

See Also:

• Constant Field Values

FONT

 public static final int FONT 
            

Font family as String or PdfFont shall be set.

See Also:

• StandardFontFamilies
• Constant Field Values

FONT_COLOR

 public static final int FONT_COLOR 
            

See Also:

• Constant Field Values

FONT_KERNING

 public static final int FONT_KERNING 
            

See Also:

• Constant Field Values

FONT_STYLE

 public static final int FONT_STYLE 
            

String value. 'normal'|'italic'|'oblique' Note, this property will be applied only if FONT has String[] value.

See Also:

• Constant Field Values

FONT_WEIGHT

 public static final int FONT_WEIGHT 
            

String value. 'normal'|'bold'|number Note, this property will be applied only if FONT has String[] value.

See Also:

• Constant Field Values

FONT_SCRIPT

 public static final int FONT_SCRIPT 
            

See Also:

• Constant Field Values

FONT_PROVIDER

 public static final int FONT_PROVIDER 
            

Shall be instance of FontProvider

See Also:

• Constant Field Values

FONT_SET

 public static final int FONT_SET 
            

Shall be instance of FontSet.

See Also:

• Constant Field Values

FONT_SIZE

 public static final int FONT_SIZE 
            

See Also:

• Constant Field Values

FORCED_PLACEMENT

 public static final int FORCED_PLACEMENT 
            

See Also:

• Constant Field Values

FULL

 public static final int FULL 
            

See Also:

• Constant Field Values

HEIGHT

 public static final int HEIGHT 
            

See Also:

• Constant Field Values

HORIZONTAL_ALIGNMENT

 public static final int HORIZONTAL_ALIGNMENT 
            

See Also:

• Constant Field Values

HORIZONTAL_BORDER_SPACING

 public static final int HORIZONTAL_BORDER_SPACING 
            

See Also:

• Constant Field Values

HORIZONTAL_SCALING

 public static final int HORIZONTAL_SCALING 
            

Value of 1 is equivalent to no scaling

See Also:

• Constant Field Values

HYPHENATION

 public static final int HYPHENATION 
            

See Also:

• Constant Field Values

ID

 public static final int ID 
            

See Also:

• Constant Field Values

IGNORE_FOOTER

 public static final int IGNORE_FOOTER 
            

See Also:

• Constant Field Values

IGNORE_HEADER

 public static final int IGNORE_HEADER 
            

See Also:

• Constant Field Values

ITALIC_SIMULATION

 public static final int ITALIC_SIMULATION 
            

See Also:

• Constant Field Values

JUSTIFY_CONTENT

 public static final int JUSTIFY_CONTENT 
            

See Also:

• Constant Field Values

KEEP_TOGETHER

 public static final int KEEP_TOGETHER 
            

See Also:

• Constant Field Values

KEEP_WITH_NEXT

 public static final int KEEP_WITH_NEXT 
            

See Also:

• Constant Field Values

LEADING

 public static final int LEADING 
            

See Also:

• Constant Field Values

LEFT

 public static final int LEFT 
            

See Also:

• Constant Field Values

LINE_DRAWER

 public static final int LINE_DRAWER 
            

See Also:

• Constant Field Values

LINE_HEIGHT

 public static final int LINE_HEIGHT 
            

See Also:

• Constant Field Values

LINK_ANNOTATION

 public static final int LINK_ANNOTATION 
            

See Also:

• Constant Field Values

LIST_START

 public static final int LIST_START 
            

See Also:

• Constant Field Values

LIST_SYMBOL

 public static final int LIST_SYMBOL 
            

See Also:

• Constant Field Values

LIST_SYMBOL_ALIGNMENT

 public static final int LIST_SYMBOL_ALIGNMENT 
            

See Also:

• Constant Field Values

LIST_SYMBOL_INDENT

 public static final int LIST_SYMBOL_INDENT 
            

See Also:

• Constant Field Values

LIST_SYMBOL_ORDINAL_VALUE

 public static final int LIST_SYMBOL_ORDINAL_VALUE 
            

See Also:

• Constant Field Values

LIST_SYMBOL_PRE_TEXT

 public static final int LIST_SYMBOL_PRE_TEXT 
            

See Also:

• Constant Field Values

LIST_SYMBOL_POSITION

 public static final int LIST_SYMBOL_POSITION 
            

See Also:

• Constant Field Values

LIST_SYMBOL_POST_TEXT

 public static final int LIST_SYMBOL_POST_TEXT 
            

See Also:

• Constant Field Values

LIST_SYMBOLS_INITIALIZED

 public static final int LIST_SYMBOLS_INITIALIZED 
            

See Also:

• Constant Field Values

MARGIN_BOTTOM

 public static final int MARGIN_BOTTOM 
            

See Also:

• Constant Field Values

MARGIN_LEFT

 public static final int MARGIN_LEFT 
            

See Also:

• Constant Field Values

MARGIN_RIGHT

 public static final int MARGIN_RIGHT 
            

See Also:

• Constant Field Values

MARGIN_TOP

 public static final int MARGIN_TOP 
            

See Also:

• Constant Field Values

MAX_HEIGHT

 public static final int MAX_HEIGHT 
            

See Also:

• Constant Field Values

MAX_WIDTH

 public static final int MAX_WIDTH 
            

See Also:

• Constant Field Values

META_INFO

 public static final int META_INFO 
            

See Also:

• Constant Field Values

MIN_HEIGHT

 public static final int MIN_HEIGHT 
            

See Also:

• Constant Field Values

MIN_WIDTH

 public static final int MIN_WIDTH 
            

See Also:

• Constant Field Values

NO_SOFT_WRAP_INLINE

 public static final int NO_SOFT_WRAP_INLINE 
            

See Also:

• Constant Field Values

OBJECT_FIT

 public static final int OBJECT_FIT 
            

See Also:

• Constant Field Values

OPACITY

 public static final int OPACITY 
            

See Also:

• Constant Field Values

ORPHANS_CONTROL

 public static final int ORPHANS_CONTROL 
            

See Also:

• Constant Field Values

OUTLINE

 public static final int OUTLINE 
            

See Also:

• Constant Field Values

OUTLINE_OFFSET

 public static final int OUTLINE_OFFSET 
            

See Also:

• Constant Field Values

OVERFLOW_WRAP

 public static final int OVERFLOW_WRAP 
            

See Also:

• Constant Field Values

OVERFLOW_X

 public static final int OVERFLOW_X 
            

See Also:

• Constant Field Values

OVERFLOW_Y

 public static final int OVERFLOW_Y 
            

See Also:

• Constant Field Values

PADDING_BOTTOM

 public static final int PADDING_BOTTOM 
            

See Also:

• Constant Field Values

PADDING_LEFT

 public static final int PADDING_LEFT 
            

See Also:

• Constant Field Values

PADDING_RIGHT

 public static final int PADDING_RIGHT 
            

See Also:

• Constant Field Values

PADDING_TOP

 public static final int PADDING_TOP 
            

See Also:

• Constant Field Values

PAGE_NUMBER

 public static final int PAGE_NUMBER 
            

See Also:

• Constant Field Values

POSITION

 public static final int POSITION 
            

See Also:

• Constant Field Values

RENDERING_MODE

 public static final int RENDERING_MODE 
            

See Also:

• Constant Field Values

RIGHT

 public static final int RIGHT 
            

See Also:

• Constant Field Values

ROTATION_ANGLE

 public static final int ROTATION_ANGLE 
            

See Also:

• Constant Field Values

ROTATION_INITIAL_HEIGHT

 public static final int ROTATION_INITIAL_HEIGHT 
            

See Also:

• Constant Field Values

ROTATION_INITIAL_WIDTH

 public static final int ROTATION_INITIAL_WIDTH 
            

See Also:

• Constant Field Values

ROTATION_POINT_X

 public static final int ROTATION_POINT_X 
            

See Also:

• Constant Field Values

ROTATION_POINT_Y

 public static final int ROTATION_POINT_Y 
            

See Also:

• Constant Field Values

ROWSPAN

 public static final int ROWSPAN 
            

See Also:

• Constant Field Values

SPACING_RATIO

 public static final int SPACING_RATIO 
            

See Also:

• Constant Field Values

SPLIT_CHARACTERS

 public static final int SPLIT_CHARACTERS 
            

See Also:

• Constant Field Values

STROKE_COLOR

 public static final int STROKE_COLOR 
            

See Also:

• Constant Field Values

STROKE_WIDTH

 public static final int STROKE_WIDTH 
            

See Also:

• Constant Field Values

SKEW

 public static final int SKEW 
            

See Also:

• Constant Field Values

TABLE_LAYOUT

 public static final int TABLE_LAYOUT 
            

See Also:

• Constant Field Values

TAB_ANCHOR

 public static final int TAB_ANCHOR 
            

See Also:

• Constant Field Values

TAB_DEFAULT

 public static final int TAB_DEFAULT 
            

See Also:

• Constant Field Values

TAB_LEADER

 public static final int TAB_LEADER 
            

See Also:

• Constant Field Values

TAB_STOPS

 public static final int TAB_STOPS 
            

See Also:

• Constant Field Values

TAGGING_HELPER

 public static final int TAGGING_HELPER 
            

See Also:

• Constant Field Values

TAGGING_HINT_KEY

 public static final int TAGGING_HINT_KEY 
            

See Also:

• Constant Field Values

TEXT_ALIGNMENT

 public static final int TEXT_ALIGNMENT 
            

See Also:

• Constant Field Values

TEXT_RENDERING_MODE

 public static final int TEXT_RENDERING_MODE 
            

Use values from PdfCanvasConstants.TextRenderingMode.

See Also:

• Constant Field Values

TEXT_RISE

 public static final int TEXT_RISE 
            

See Also:

• Constant Field Values

TOP

 public static final int TOP 
            

See Also:

• Constant Field Values

TRANSFORM

 public static final int TRANSFORM 
            

See Also:

• Constant Field Values

TYPOGRAPHY_CONFIG

 public static final int TYPOGRAPHY_CONFIG 
            

See Also:

• Constant Field Values

UNDERLINE

 public static final int UNDERLINE 
            

See Also:

• Constant Field Values

VERTICAL_ALIGNMENT

 public static final int VERTICAL_ALIGNMENT 
            

See Also:

• Constant Field Values

VERTICAL_BORDER_SPACING

 public static final int VERTICAL_BORDER_SPACING 
            

See Also:

• Constant Field Values

INLINE_VERTICAL_ALIGNMENT

 public static final int INLINE_VERTICAL_ALIGNMENT 
            

See Also:

• Constant Field Values

VERTICAL_SCALING

 public static final int VERTICAL_SCALING 
            

Value of 1 is equivalent to no scaling

See Also:

• Constant Field Values

WIDOWS_CONTROL

 public static final int WIDOWS_CONTROL 
            

See Also:

• Constant Field Values

WIDTH

 public static final int WIDTH 
            

See Also:

• Constant Field Values

WORD_SPACING

 public static final int WORD_SPACING 
            

See Also:

• Constant Field Values

Method Details

isPropertyInherited

 public static boolean isPropertyInherited 
             (int property) 
            

This method checks whether a Property, in order to be picked up by the rendering engine, must be defined on the current element or renderer (return false), or may be defined in one of its parent elements or renderers (return true).

Parameters:

property - the ID, defined in this class, of the property to check

Returns:

whether the property type is inheritable