Class AreaHolderBlock

java.lang.Object

org.ofdrw.layout.element.Div<AreaHolderBlock>

org.ofdrw.layout.element.AreaHolderBlock

All Implemented Interfaces:

ElementSplit, RenderPrepare

public class AreaHolderBlock
extends Div<AreaHolderBlock>

区域占位区块

该元素属性与Div属性一致，也就是说可以绘制边框等内容。

用于构造页面中一个用于容纳将来可能出现的页面元素的结构，该结构不做任何事情仅仅是占位。 被添加到页面中的 区域占位区块 将会生成一个特别定位坐标到 AreaHolderBlocks.xml 文件，详见 AreaHolderBlocks

绘制行为详见渲染器：AreaHolderBlock

注意AreaHolderBlock将会受到 Border 与 Padding的影响，可绘制区域仅为去除了Border与Padding的内的区域。

Since:

2023-10-28 12:24:06

Author:

权观宇

Field Summary

Fields

Modifier and Type	Field	Description
String	areaName	占位区域名称

Constructor Summary

Constructors

Constructor	Description
AreaHolderBlock(String areaName, double x, double y, double w, double h)	在指定位置 创建AreaHolderBlock对象
AreaHolderBlock(String areaName, Double width, Double height)	创建AreaHolderBlock对象

Method Summary

Modifier and Type	Method	Description
Rectangle	doPrepare(Double widthLimit)	Canvas 不接受宽度重设
String	elementType()	获取元素类型名称
String	getAreaName()	获取 区域名称
AreaHolderBlock	setAreaName(String areaName)	设置 区域名称

Methods inherited from class Div

box, clone, contentSplitAdjust, copyTo, getBackgroundColor, getBorder, getBorderBottom, getBorderColor, getBorderDash, getBorderLeft, getBorderRight, getBorderTop, getClear, getDisplay, getFloat, getHeight, getLayer, getLeft, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getOnRenderFinish, getOpacity, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTop, getWidth, getX, getY, heightPlus, isBlockElement, isIntegrity, isNoBorder, isPlaceholder, onRenderFinish, placeholder, placeholder, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorder, setBorderBottom, setBorderColor, setBorderColor, setBorderColor, setBorderDash, setBorderLeft, setBorderRight, setBorderTop, setBox, setClear, setDisplay, setFloat, setHeight, setIntegrity, setLayer, setLeft, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setOpacity, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPlaceholder, setPosition, setRight, setTop, setWidth, setX, setXY, setY, split, toString, widthPlus

Modifier and Type	Method	Description
Rectangle	box()	获取模型区域大小
Div	clone()	克隆Div
<T extends Div> Div[]	contentSplitAdjust(double sHeight, T div1, T div2)	内容分割调整
<T extends Div> T	copyTo(T div)	Clone到制定对象
int[]	getBackgroundColor()
Double[]	getBorder()
Double	getBorderBottom()
int[]	getBorderColor()	获取 边框颜色
Double[]	getBorderDash()	获取 边框虚线样式
Double	getBorderLeft()
Double	getBorderRight()
Double	getBorderTop()
Clear	getClear()
Display	getDisplay()	获取 显示样式
AFloat	getFloat()
Double	getHeight()
org.ofdrw.core.basicStructure.pageObj.layer.Type	getLayer()	返回 图层
Double	getLeft()
Double[]	getMargin()
Double	getMarginBottom()
Double	getMarginLeft()
Double	getMarginRight()
Double	getMarginTop()
ElementRenderFinishHandler	getOnRenderFinish()	获取渲染完成回调事件
Double	getOpacity()	获取透明度
Double[]	getPadding()	获取内边距
Double	getPaddingBottom()
Double	getPaddingLeft()
Double	getPaddingRight()
Double	getPaddingTop()
Position	getPosition()
Double	getRight()
Double	getTop()
Double	getWidth()
Double	getX()
Double	getY()
double	heightPlus()
boolean	isBlockElement()	是否是块级元素
Boolean	isIntegrity()	元素是否可以拆分
boolean	isNoBorder()	是否存在边框
boolean	isPlaceholder()	判断是否为占位符
void	onRenderFinish(ElementRenderFinishHandler renderFinishHandler)	设置渲染完成回调事件
static Div	placeholder(double width, double height, AFloat aFloat)	空间占位符
static Div	placeholder(Rectangle rec, AFloat aFloat)	空间占位符
AreaHolderBlock	setBackgroundColor(int[] backgroundColor)	设置背景颜色 RGB
AreaHolderBlock	setBackgroundColor(int r, int g, int b)	设置背景颜色 RGB
AreaHolderBlock	setBackgroundColor(String color)	设置 背景颜色
AreaHolderBlock	setBorder(Double... border)	设置 边框宽度
AreaHolderBlock	setBorderBottom(Double bottom)
AreaHolderBlock	setBorderColor(int[] rgb)	设置 边框颜色
AreaHolderBlock	setBorderColor(int r, int g, int b)	设置边框颜色
AreaHolderBlock	setBorderColor(String color)	设置 边框颜色
AreaHolderBlock	setBorderDash(Double... dash)	设置 边框虚线样式
AreaHolderBlock	setBorderLeft(Double left)
AreaHolderBlock	setBorderRight(Double right)
AreaHolderBlock	setBorderTop(Double top)
AreaHolderBlock	setBox(Double x, Double y, Double width, Double height)	设置盒式模型的主要属性
AreaHolderBlock	setClear(Clear clear)
AreaHolderBlock	setDisplay(Display display)	设置 显示样式
AreaHolderBlock	setFloat(AFloat aFloat)	设置浮动样式
AreaHolderBlock	setHeight(Double height)
AreaHolderBlock	setIntegrity(Boolean integrity)
AreaHolderBlock	setLayer(org.ofdrw.core.basicStructure.pageObj.layer.Type layer)	设置 图层
AreaHolderBlock	setLeft(Double left)
AreaHolderBlock	setMargin(Double... margin)	设置 外边距
AreaHolderBlock	setMarginBottom(Double bottom)
AreaHolderBlock	setMarginLeft(Double left)
AreaHolderBlock	setMarginRight(Double right)
AreaHolderBlock	setMarginTop(Double top)
AreaHolderBlock	setOpacity(Double opacity)	设置透明度
AreaHolderBlock	setPadding(Double... padding)	设置 内边距
AreaHolderBlock	setPaddingBottom(Double bottom)
AreaHolderBlock	setPaddingLeft(Double left)
AreaHolderBlock	setPaddingRight(Double right)
AreaHolderBlock	setPaddingTop(Double top)
AreaHolderBlock	setPlaceholder(boolean placeholder)	设置是否为 占位符
AreaHolderBlock	setPosition(Position position)
AreaHolderBlock	setRight(Double right)
AreaHolderBlock	setTop(Double top)
AreaHolderBlock	setWidth(Double width)
AreaHolderBlock	setX(Double x)
AreaHolderBlock	setXY(Double x, Double y)	设置位置
AreaHolderBlock	setY(Double y)
Div[]	split(double sHeight)	根据给定的高度切分元素
String	toString()
double	widthPlus()

Methods inherited from class Object

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

Field Details

areaName

public String areaName

占位区域名称

用于唯一定位区域占位区块，请确保该名称在文档范围内唯一。

Constructor Details

AreaHolderBlock

public AreaHolderBlock(String areaName,
 Double width,
 Double height)

创建AreaHolderBlock对象

AreaHolderBlock的宽度和高度必须在创建时指定

Parameters:

areaName - 区域名称，用于唯一定位区域占位区块，请确保该名称在文档范围内唯一。

width - 宽度（单位：毫米mm）

height - 高度（单位：毫米mm）

AreaHolderBlock

public AreaHolderBlock(String areaName,
 double x,
 double y,
 double w,
 double h)

在指定位置 创建AreaHolderBlock对象

Parameters:

areaName - 区域名称，用于唯一定位区域占位区块，请确保该名称在文档范围内唯一。

x - 画布左上角的x坐标

y - 画布左上角的y坐标

w - 画布的宽度

h - 画布的高度

Method Details

getAreaName

public String getAreaName()

获取 区域名称

Returns:

区域名称

setAreaName

public AreaHolderBlock setAreaName(String areaName)

设置 区域名称

Parameters:

areaName - 区域名称

Returns:

this

doPrepare

public Rectangle doPrepare(Double widthLimit)

Canvas 不接受宽度重设

Specified by:

doPrepare in interface RenderPrepare

Overrides:

doPrepare in class Div<AreaHolderBlock>

Parameters:

widthLimit - 宽度限制

Returns:

元素尺寸

elementType

public String elementType()

获取元素类型名称

用于标识元素类型，选择合适的处理器，自定义元素请重写该方法

关联绘制器：DivRender

Overrides:

elementType in class Div<AreaHolderBlock>

Returns:

元素类型名称