CElementPropertyContainer

java.lang.Object
- CPDFGeneration.layout.CElementPropertyContainer

All Implemented Interfaces:: CIElement

Direct Known Subclasses:: CAbstractElement, CStyle

public abstract class CElementPropertyContainer
extends java.lang.Object
implements CIElement

Field Summary

Fields
Modifier and Type Field and Description

long elementPtr

Fields
Modifier and Type	Field and Description
`long`	`elementPtr`

Constructor Summary

Constructors
Constructor and Description

CElementPropertyContainer(long ptr)
Create a property container with native pointer.

Constructors
Constructor and Description
`CElementPropertyContainer(long ptr)` Create a property container with native pointer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteProperty(CProperty property)` Delete/unset a property.
`java.util.HashMap<java.lang.Integer,java.lang.Object>`	`getProperties()` Get all properties of the current element.
`CColor`	`getStrokeColor()` Get stroke color.
`float`	`getStrokeWidth()` Get stroke width.
`boolean`	`hasProperty(CProperty property)` Check whether a property exists.
`CElementPropertyContainer`	`setAbsolutePosition(float left, float bottom, CUnitValue width)` Set absolute position using a width specified as a `CUnitValue`.
`CElementPropertyContainer`	`setAbsolutePosition(float left, float bottom, float width)` Set absolute position using a width specified in points.
`CElementPropertyContainer`	`setBackgroundColor(CColor color)` Set background color.
`CElementPropertyContainer`	`setBackgroundImage(CBackgroundImage bg)` Set background images.
`CElementPropertyContainer`	`setBorder(CBorder border)` Set border for all sides.
`CElementPropertyContainer`	`setBorderBottom(CBorder border)` Set bottom border.
`CElementPropertyContainer`	`setBorderBottomLeftRadius(CBorderRadius borderRadius)` Set bottom-left corner radius.
`CElementPropertyContainer`	`setBorderBottomRightRadius(CBorderRadius borderRadius)` Set bottom-right corner radius.
`CElementPropertyContainer`	`setBorderLeft(CBorder border)` Set left border.
`CElementPropertyContainer`	`setBorderRadius(CBorderRadius borderRadius)` Set border radius for all corners.
`CElementPropertyContainer`	`setBorderRight(CBorder border)` Set right border.
`CElementPropertyContainer`	`setBorderTop(CBorder border)` Set top border.
`CElementPropertyContainer`	`setBorderTopLeftRadius(CBorderRadius borderRadius)` Set top-left corner radius.
`CElementPropertyContainer`	`setBorderTopRightRadius(CBorderRadius borderRadius)` Set top-right corner radius.
`CElementPropertyContainer`	`setCharacterSpacing(float charSpacing)` Set character spacing.
`CElementPropertyContainer`	`setFontColor(CColor fontColor)` Set font color.
`CElementPropertyContainer`	`setFontFamily(java.lang.String fontFamily)` Set font family.
`CElementPropertyContainer`	`setFontSize(float fontSize)` Set font size.
`CElementPropertyContainer`	`setFontStyle(CFontStyle fontStyle)` Set font style.
`CElementPropertyContainer`	`setFontWeight(CFontWeight fontWeight)` Set font weight.
`CElementPropertyContainer`	`setHorizontalAlignment(CHorizontalAlignment horizontalAlignment)` Set horizontal alignment.
`CElementPropertyContainer`	`setInlineVerticalAlignment(CVerticalAlignment inlineVerticalAlignment)` Set inline vertical alignment.
`CElementPropertyContainer`	`setOpacity(float opacity)` Set opacity.
`CElementPropertyContainer`	`setStrokeColor(CColor color)` Set stroke color.
`CElementPropertyContainer`	`setStrokeWidth(float strokeWidth)` Set stroke width.
`CElementPropertyContainer`	`setTextAlignment(CTextAlignment textAlignment)` Set text alignment.
`CElementPropertyContainer`	`setUnderline(CColor c)` Set underline color.
`CElementPropertyContainer`	`setWordSpacing(float wordSpacing)` Set word spacing.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface CPDFGeneration.layout.CIElement
getType, isAbsolute

- Field Detail
  - elementPtr
```
public long elementPtr
```
- Constructor Detail
  - CElementPropertyContainer
```
public CElementPropertyContainer(long ptr)
```
    Create a property container with native pointer.
    
    Parameters:
    
    ptr - native element pointer/handle
- Method Detail
  - getProperties
```
public java.util.HashMap<java.lang.Integer,java.lang.Object> getProperties()
```
    Get all properties of the current element.
    The returned map uses the native property id as the key, and the stored property value as the value.
    
    Returns:
    
    a map of propertyId -> propertyValue
  - hasProperty
```
public boolean hasProperty(CProperty property)
```
    Check whether a property exists.
    
    Parameters:
    
    property - property identifier
    
    Returns:
    
    true if the property exists; otherwise false
  - deleteProperty
```
public void deleteProperty(CProperty property)
```
    Delete/unset a property.
    
    Parameters:
    
    property - property identifier; if null, this method does nothing
  - setAbsolutePosition
```
public CElementPropertyContainer setAbsolutePosition(float left,
                                                     float bottom,
                                                     float width)
```
    Set absolute position using a width specified in points.
    
    Parameters:
    
    left - left position
    
    bottom - bottom position
    
    width - width in points
    
    Returns:
    
    this container for method chaining
  - setAbsolutePosition
```
public CElementPropertyContainer setAbsolutePosition(float left,
                                                     float bottom,
                                                     CUnitValue width)
```
    Set absolute position using a width specified as a CUnitValue.
    
    Parameters:
    
    left - left position
    
    bottom - bottom position
    
    width - width as CUnitValue; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setFontFamily
```
public CElementPropertyContainer setFontFamily(java.lang.String fontFamily)
```
    Set font family.
    
    Parameters:
    
    fontFamily - font family name
    
    Returns:
    
    this container for method chaining
  - setFontColor
```
public CElementPropertyContainer setFontColor(CColor fontColor)
```
    Set font color.
    
    Parameters:
    
    fontColor - font color (RGBA)
    
    Returns:
    
    this container for method chaining
  - setFontSize
```
public CElementPropertyContainer setFontSize(float fontSize)
```
    Set font size.
    
    Parameters:
    
    fontSize - font size
    
    Returns:
    
    this container for method chaining
  - setFontWeight
```
public CElementPropertyContainer setFontWeight(CFontWeight fontWeight)
```
    Set font weight.
    
    Parameters:
    
    fontWeight - font weight enum; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setFontStyle
```
public CElementPropertyContainer setFontStyle(CFontStyle fontStyle)
```
    Set font style.
    
    Parameters:
    
    fontStyle - font style enum; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setTextAlignment
```
public CElementPropertyContainer setTextAlignment(CTextAlignment textAlignment)
```
    Set text alignment.
    
    Parameters:
    
    textAlignment - text alignment enum; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setInlineVerticalAlignment
```
public CElementPropertyContainer setInlineVerticalAlignment(CVerticalAlignment inlineVerticalAlignment)
```
    Set inline vertical alignment.
    
    Parameters:
    
    inlineVerticalAlignment - inline vertical alignment enum; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setHorizontalAlignment
```
public CElementPropertyContainer setHorizontalAlignment(CHorizontalAlignment horizontalAlignment)
```
    Set horizontal alignment.
    
    Parameters:
    
    horizontalAlignment - horizontal alignment enum; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setCharacterSpacing
```
public CElementPropertyContainer setCharacterSpacing(float charSpacing)
```
    Set character spacing.
    
    Parameters:
    
    charSpacing - character spacing value
    
    Returns:
    
    this container for method chaining
  - setWordSpacing
```
public CElementPropertyContainer setWordSpacing(float wordSpacing)
```
    Set word spacing.
    
    Parameters:
    
    wordSpacing - word spacing value
    
    Returns:
    
    this container for method chaining
  - setBackgroundColor
```
public CElementPropertyContainer setBackgroundColor(CColor color)
```
    Set background color.
    
    Parameters:
    
    color - background color (RGBA); if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBackgroundImage
```
public CElementPropertyContainer setBackgroundImage(CBackgroundImage bg)
```
    Set background images.
    
    Parameters:
    
    bg - background image sources container; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorder
```
public CElementPropertyContainer setBorder(CBorder border)
```
    Set border for all sides.
    
    Parameters:
    
    border - border object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorderRight
```
public CElementPropertyContainer setBorderRight(CBorder border)
```
    Set right border.
    
    Parameters:
    
    border - border object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorderTop
```
public CElementPropertyContainer setBorderTop(CBorder border)
```
    Set top border.
    
    Parameters:
    
    border - border object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorderBottom
```
public CElementPropertyContainer setBorderBottom(CBorder border)
```
    Set bottom border.
    
    Parameters:
    
    border - border object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorderLeft
```
public CElementPropertyContainer setBorderLeft(CBorder border)
```
    Set left border.
    
    Parameters:
    
    border - border object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorderRadius
```
public CElementPropertyContainer setBorderRadius(CBorderRadius borderRadius)
```
    Set border radius for all corners.
    
    Parameters:
    
    borderRadius - border radius object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorderBottomLeftRadius
```
public CElementPropertyContainer setBorderBottomLeftRadius(CBorderRadius borderRadius)
```
    Set bottom-left corner radius.
    
    Parameters:
    
    borderRadius - border radius object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorderBottomRightRadius
```
public CElementPropertyContainer setBorderBottomRightRadius(CBorderRadius borderRadius)
```
    Set bottom-right corner radius.
    
    Parameters:
    
    borderRadius - border radius object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorderTopLeftRadius
```
public CElementPropertyContainer setBorderTopLeftRadius(CBorderRadius borderRadius)
```
    Set top-left corner radius.
    
    Parameters:
    
    borderRadius - border radius object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setBorderTopRightRadius
```
public CElementPropertyContainer setBorderTopRightRadius(CBorderRadius borderRadius)
```
    Set top-right corner radius.
    
    Parameters:
    
    borderRadius - border radius object; if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - getStrokeColor
```
public CColor getStrokeColor()
```
    Get stroke color.
    
    Returns:
    
    stroke color (RGBA)
  - setStrokeColor
```
public CElementPropertyContainer setStrokeColor(CColor color)
```
    Set stroke color.
    
    Parameters:
    
    color - stroke color (RGBA); if null, this method does nothing
    
    Returns:
    
    this container for method chaining
  - setStrokeWidth
```
public CElementPropertyContainer setStrokeWidth(float strokeWidth)
```
    Set stroke width.
    
    Parameters:
    
    strokeWidth - stroke width
    
    Returns:
    
    this container for method chaining
  - getStrokeWidth
```
public float getStrokeWidth()
```
    Get stroke width.
    
    Returns:
    
    stroke width
  - setUnderline
```
public CElementPropertyContainer setUnderline(CColor c)
```
    Set underline color.
    
    Parameters:
    
    c - underline color (only RGB channels are used by the native call)
    
    Returns:
    
    this container for method chaining
  - setOpacity
```
public CElementPropertyContainer setOpacity(float opacity)
```
    Set opacity.
    
    Parameters:
    
    opacity - opacity value (typically 0.0 to 1.0)
    
    Returns:
    
    this container for method chaining

Class CElementPropertyContainer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface CPDFGeneration.layout.CIElement

Field Detail

elementPtr

Constructor Detail

CElementPropertyContainer

Method Detail

getProperties

hasProperty

deleteProperty

setAbsolutePosition

setAbsolutePosition

setFontFamily

setFontColor

setFontSize

setFontWeight

setFontStyle

setTextAlignment

setInlineVerticalAlignment

setHorizontalAlignment

setCharacterSpacing

setWordSpacing

setBackgroundColor

setBackgroundImage

setBorder

setBorderRight

setBorderTop

setBorderBottom

setBorderLeft

setBorderRadius

setBorderBottomLeftRadius

setBorderBottomRightRadius

setBorderTopLeftRadius

setBorderTopRightRadius

getStrokeColor

setStrokeColor

setStrokeWidth

getStrokeWidth

setUnderline

setOpacity