org.ofdrw.layout.areaholder.AreaHolderBlocks Maven / Gradle / Ivy
package org.ofdrw.layout.areaholder;
import org.dom4j.Element;
import org.ofdrw.core.OFDElement;
import java.util.List;
/**
* 【OFDRW 扩展】 区域占位区块列表 AreaHolderBlocks.xml
*
* 区域占位区块列表 是 OFDRW 扩展的对象，区域占位区块列表可以包含文档中的多个 区域占位区块对象 ，注意每个 区域占位区块对象 的
* 区域名称在 区域占位区块列表 中应该唯一。
*
* 通常来说 AreaHolderBlocks.xml 位于文档目录中，例如：`/Doc_0/AreaHolderBlocks.xml`。
*
* @author 权观宇
* @since 2023-10-28 15:30:36
*/
public class AreaHolderBlocks extends OFDElement {
/**
* 【OFDRW 扩展】 区域占位区块列表 文件名称
*/
public static final String AreaHolderBlocksFile = "AreaHolderBlocks.xml";
public AreaHolderBlocks(Element proxy) {
super(proxy);
}
public AreaHolderBlocks() {
super("AreaHolderBlocks");
}
/**
* 【可选】
* 增加 区域占位区块
*
* @param area 区域占位区块
* @return this
*/
public AreaHolderBlocks addAreaHolderBlock(CT_AreaHolderBlock ...area) {
if (area == null || area.length == 0) {
return this;
}
for (CT_AreaHolderBlock holderBlock : area) {
this.add(holderBlock);
}
return this;
}
/**
* 【可选】
* 获取 区域占位区块 序列
*
* @return 区域占位区块 序列
*/
public List getAreaHolderBlocks() {
return this.getOFDElements("AreaHolderBlock", CT_AreaHolderBlock::new);
}
}