org.dromara.pdf.pdfbox.core.component

Class Container

java.lang.Object

org.dromara.pdf.pdfbox.core.base.AbstractBase

org.dromara.pdf.pdfbox.core.component.AbstractComponent

org.dromara.pdf.pdfbox.core.component.Container

All Implemented Interfaces:

Closeable, AutoCloseable, Component

public class Container
extends AbstractComponent

容器组件

Since:

1.8

Copyright (c) 2020 xsx All Rights Reserved. x-easypdf-pdfbox is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

Author:

xsx

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	backgroundColor 背景颜色
protected List<Component>	components 组件列表
protected HorizontalAlignment	contentHorizontalAlignment 内容水平对齐方式
protected VerticalAlignment	contentVerticalAlignment 内容垂直对齐方式
protected Float	height 高度
protected Boolean	isPagingBorder 是否分页边框
protected Boolean	isTogether 是否整体换行
protected PagingEvent	pagingEvent 分页事件
protected Float	width 宽度

Fields inherited from class org.dromara.pdf.pdfbox.core.component.AbstractComponent

beginX, beginY, borderConfiguration, horizontalAlignment, isBreak, isCustomPosition, isWrap, marginConfiguration, pagingCondition, pagingEvents, relativeBeginX, relativeBeginY, verticalAlignment

Fields inherited from class org.dromara.pdf.pdfbox.core.base.AbstractBase

contentMode, context, isResetContentStream, log

Constructor Summary

Constructors

Constructor and Description
Container(Page page) 有参构造

Method Summary

Modifier and Type	Method and Description
protected float	addBorder(Float beginX, Float beginY, BorderInfo info) 添加边框
void	addComponents(Component... components) 添加组件
void	addComponents(List<Component> components) 添加组件
protected Page	executeBreak() 执行分页
protected float	getMinWidth() 获取最小宽度
ComponentType	getType() 获取类型
protected void	init() 初始化
protected void	reset() 重置
void	setComponents(Component... components) 设置
void	setComponents(List<Component> components) 设置组件
void	setHeight(float height) 设置高度
void	setWidth(float width) 设置宽度
protected void	writeContents() 写入内容

Methods inherited from class org.dromara.pdf.pdfbox.core.component.AbstractComponent

addPagingEvent, checkPaging, checkPaging, checkPaging, checkWrap, close, getBase, getBorderBottomColor, getBorderDottedSpacing, getBorderLeftColor, getBorderLineCapStyle, getBorderLineLength, getBorderLineStyle, getBorderLineWidth, getBorderRightColor, getBorderTopColor, getBottom, getIsBorderBottom, getIsBorderLeft, getIsBorderRight, getIsBorderTop, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPage, initBeginX, initBeginXY, initBeginY, initBeginYForPaging, isNeedWrap, isPaging, isPagingComponent, isWrap, processBreak, render, reset, resetXY, setBeginX, setBeginX, setBeginY, setBeginY, setBorderBottomColor, setBorderColor, setBorderDottedSpacing, setBorderLeftColor, setBorderLineCapStyle, setBorderLineLength, setBorderLineStyle, setBorderLineWidth, setBorderRightColor, setBorderRightColor, setBorderTopColor, setIsBorder, setIsBorderBottom, setIsBorderLeft, setIsBorderRight, setIsBorderTop, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, virtualRender, wrap

Methods inherited from class org.dromara.pdf.pdfbox.core.base.AbstractBase

init, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dromara.pdf.pdfbox.core.component.Component

getContext, getPagingCondition, getPagingEvents, setHorizontalAlignment, setVerticalAlignment

Field Detail

backgroundColor

protected Color backgroundColor

背景颜色

width

protected Float width

宽度

height

protected Float height

高度

components

protected List<Component> components

组件列表

pagingEvent

protected PagingEvent pagingEvent

分页事件

isTogether

protected Boolean isTogether

是否整体换行

isPagingBorder

protected Boolean isPagingBorder

是否分页边框

contentHorizontalAlignment

protected HorizontalAlignment contentHorizontalAlignment

内容水平对齐方式

contentVerticalAlignment

protected VerticalAlignment contentVerticalAlignment

内容垂直对齐方式

Constructor Detail

Container

public Container(Page page)

有参构造

Parameters:

page - 页面

Method Detail

setWidth

public void setWidth(float width)

设置宽度

Parameters:

width - 宽度

setHeight

public void setHeight(float height)

设置高度

Parameters:

height - 高度

setComponents

public void setComponents(List<Component> components)

设置组件

Parameters:

components - 组件

setComponents

public void setComponents(Component... components)

设置

Parameters:

components - 组件

addComponents

public void addComponents(List<Component> components)

添加组件

Parameters:

components - 组件

addComponents

public void addComponents(Component... components)

添加组件

Parameters:

components - 组件

getType

public ComponentType getType()

获取类型

Returns:

返回类型

init

protected void init()

初始化

Overrides:

init in class AbstractComponent

getMinWidth

protected float getMinWidth()

获取最小宽度

Specified by:

getMinWidth in class AbstractComponent

Returns:

返回最小宽度

writeContents

protected void writeContents()

写入内容

Specified by:

writeContents in class AbstractComponent

reset

protected void reset()

重置

Specified by:

reset in class AbstractComponent

executeBreak

protected Page executeBreak()

执行分页

Overrides:

executeBreak in class AbstractComponent

addBorder

protected float addBorder(Float beginX,
                          Float beginY,
                          BorderInfo info)

添加边框

Parameters:

beginX - 组件渲染前X轴坐标

beginY - 组件渲染前Y轴坐标

info - 容器信息