Form

java.lang.Object
- com.fr.data.AbstractTableDataSource
- - com.fr.base.io.IOFile
  - - com.fr.form.main.Form

所有已实现的接口:

AttrMark, BaseBook, ParameterHolder, TableDataSource, FormProvider, BaseFormProvider, PrivilegeEditedRoleProvider, FitProvider, FCloneable, XMLable, XMLReadable, XMLWriter, java.io.Serializable, java.lang.Cloneable

直接已知子类:

FormParameterUI, WebClassForm
```
public class Form
extends IOFile
implements PrivilegeEditedRoleProvider, FormProvider, ParameterHolder, FitProvider
```
表单

另请参阅:
序列化表格

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`_SHOWPARA`
`static java.lang.String`	`_SHOWPARATEMPLATE`
`static int`	`DEFAULT_FIT`
`static java.lang.String`	`FIT`
`static java.lang.String`	`FIT_STATE`
`protected ReportFitAttr`	`fitAttr`
`protected FormMobileAttr`	`mobileAttr`
`static int`	`NONE_FIT`
`static java.lang.String`	`PAPER_HEIGHT`
`static java.lang.String`	`PAPER_WHDTH`
`protected java.util.Set<Parameter>`	`parameters`

从类继承的字段 com.fr.base.io.IOFile
ANA_PREVIEW_TYPE, DEFAULT_PREVIEW_TYPE, WRITE_ENHANCE_PREVIEW_TYPE, WRITE_PREVIEW_TYPE

从类继承的字段 com.fr.data.AbstractTableDataSource
tableDataList

从接口继承的字段 com.fr.data.TableDataSource
KEY

构造器概要

构造器
构造器和说明
`Form()` 默认构造器。
`Form(WAbsoluteLayout container)` 将container做为表单底层容器。
`Form(WLayout container)` 将container做为表单底层容器。

方法概要

方法
限定符和类型	方法和说明
`protected void`	`_renameTableData(java.lang.String oldName, java.lang.String newName)`
`void`	`addParameter(Parameter parameter)` 加入参数
`void`	`clearParameters()` 清除参数
`java.lang.Object`	`clone()`
`protected void`	`compatibleOldParameter(XMLableReader reader)`
`JSONObject`	`createContentJSONConfig(Repository repo, Calculator ca)` 生成内容的json配置
`JSONObject`	`createContentJSONConfig(Repository repo, Calculator ca, boolean displayContent)` 生成内容的json配置
`JSONObject`	`createJSONConfig(Repository repo, Calculator ca, NodeVisitor nodeVisitor)` 生成Form内控件的配置信息。
`JSONObject`	`createPara4Mobile(Repository repo, TemplateSessionIDInfo sessionIDInfor)` 生成Form中参数界面的json
`JSONObject`	`createParaJSONConfig(Repository repo, Calculator ca)` 生成Form中参数界面的json
`void`	`dealInVisible()`
`void`	`executeElementCases(WidgetSessionIDInfor sessionIDInfo, java.util.Map<java.lang.String,java.lang.Object> para)` 计算所有的报表块, 并将结果放入sessionidinfo
`boolean`	`export(java.io.OutputStream outputStream)` 将该对象写入指定的输出流中输出
`BaseChartEditor[]`	`getAllCharts()`
`java.lang.String[]`	`getAllEditedRoleSet()`
`java.lang.Object`	`getCellValueInElementcase(java.lang.String elementName, java.lang.String columnRow)` 获取指定路径的单元格的值
`WLayout`	`getContainer()` 获得整个表单容器，即表单最底层容器。
`FormElementCaseProvider`	`getElementCaseByName(java.lang.String name)` 获取指定名称的报表块, 非控件
`ElementCaseEditorProvider[]`	`getElementCases()` 获取表单中所有的报表块
`FormMobileAttr`	`getFormMobileAttr()`
`Parameter[]`	`getParameters()` 获取参数
`ReportFitAttr`	`getReportFitAttr()`
`Parameter[]`	`getTemplateParameters()` 获取表单存储的参数
`Widget`	`getWidgetByName(java.lang.String name)` 获取表单中指定名字的控件
`java.util.Map<java.lang.String,java.lang.Object>`	`getWidgetDefaultValueMap()` 获取控件默认值的map
`java.util.Map<java.lang.String,java.lang.Object>`	`getWidgetDefaultValueMap(java.util.Map<java.lang.String,java.lang.Object> para, Repository repo)` 获取控件默认值的map, 如果值已经包含在para中, 那么优先使用para中的如果是公式, 那么用calculator去计算他的结果值.
`Widget`	`getWidgetWithBound(java.lang.String name)` 获取表单中指定名字的控件(不对WTitleLayout和WScaleLayout进一步处理)
`boolean`	`initWidgetData(Repository repo, Calculator ca)` 处理控件数据, 若发生Exception则返回False
`boolean`	`initWidgetData(Widget widget, Repository repo, Calculator ca)` 处理控件数据, 若发生Exception则返回False
`boolean`	`isFitInBrowser()`
`boolean`	`isNameExist(java.lang.String name)` 判断某控件名是否已存在
`protected void`	`mainContent(XMLPrintWriter writer)` 写Form的主体部分
`protected java.lang.String`	`openTag()` Form的IO标示
`boolean`	`parseFontFit(ReportFitAttr fitAttr)`
`protected java.lang.Object`	`processDataBinding(Widget widget, Calculator calculator)`
`void`	`readStream(java.io.InputStream in)` 从输入流中读取表单
`void`	`readXML(XMLableReader reader)` read XML
`void`	`removeCompInterval()` 移除组件边距
`void`	`removeParaLayout()` 删除参数面板
`void`	`removeParameter(Parameter parameter)` 清除某参数
`void`	`renameTableData(Widget container, java.lang.String oldName, java.lang.String newName)` 重命名指定容器内所有widget的数据集
`static void`	`replaceBoundsWidget(WLayout layout, Widget newWidget)` 根据新旧控件的名字替换表单中的控件
`void`	`resizeFormElems(java.util.Map<java.lang.String,java.lang.Object> para)`
`void`	`resizeFormWithBrowser(java.util.Map<java.lang.String,java.lang.Object> para)`
`void`	`setContainer(WLayout container)` 设置表单最底层容器。
`void`	`setFormMobileAttr(FormMobileAttr attr)`
`void`	`setReportFitAttr(ReportFitAttr fitAttr)`
`static void`	`traversalFormWidget(Widget widget, WidgetGather gather)` 遍历Form中的所有widget
`static void`	`traversalWidget(Widget widget, WidgetGather gather, java.lang.Class clazz)` 遍历Form中的所有widget
`void`	`writeXML(XMLPrintWriter writer)` write XML

从类继承的方法 com.fr.base.io.IOFile
addAttrMark, getAllMarkName, getAttrMark, getDesignerVersion, getPreviewType, getTemplateID, getXMLDesignerVersion, getXmlVersion, isHigherThanCurrent, readDesign, readExtra, setDesignerVersion, setPreviewType, setTemplateID, setXmlVersion, suffix, writeDesign, writeExtra

从类继承的方法 com.fr.data.AbstractTableDataSource
clearAllTableData, copyDataSourceAttr, equals, getTableData, getTableDataNameIterator, putTableData, removeTableData, renameTableData

从类继承的方法 java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.fr.data.TableDataSource
clearAllTableData, getTableData, getTableDataNameIterator, putTableData, removeTableData, renameTableData

- 字段详细资料
  - FIT
```
public static final java.lang.String FIT
```
    另请参阅:
    常量字段值
  - FIT_STATE
```
public static final java.lang.String FIT_STATE
```
    另请参阅:
    常量字段值
  - PAPER_WHDTH
```
public static final java.lang.String PAPER_WHDTH
```
    另请参阅:
    常量字段值
  - PAPER_HEIGHT
```
public static final java.lang.String PAPER_HEIGHT
```
    另请参阅:
    常量字段值
  - _SHOWPARA
```
public static final java.lang.String _SHOWPARA
```
    另请参阅:
    常量字段值
  - _SHOWPARATEMPLATE
```
public static final java.lang.String _SHOWPARATEMPLATE
```
    另请参阅:
    常量字段值
  - DEFAULT_FIT
```
public static final int DEFAULT_FIT
```
    另请参阅:
    常量字段值
  - NONE_FIT
```
public static final int NONE_FIT
```
    另请参阅:
    常量字段值
  - fitAttr
```
protected ReportFitAttr fitAttr
```
  - parameters
```
protected java.util.Set<Parameter> parameters
```
  - mobileAttr
```
protected FormMobileAttr mobileAttr
```
- 构造器详细资料
  - Form
```
public Form()
```
    默认构造器。这个构造体将创建一个空的绝对定位布局作为表单底层容器。
  - Form
```
public Form(WAbsoluteLayout container)
```
    将container做为表单底层容器。
    
    参数:
    container - 这个container必须是绝对定位布局
  - Form
```
public Form(WLayout container)
```
    将container做为表单底层容器。
    
    参数:
    container - 任意Layout
- 方法详细资料
  - traversalFormWidget
```
public static void traversalFormWidget(Widget widget,
                       WidgetGather gather)
```
    遍历Form中的所有widget
    
    参数:
    widget - 控件
    gather - 控件集合
  - traversalWidget
```
public static void traversalWidget(Widget widget,
                   WidgetGather gather,
                   java.lang.Class clazz)
```
    遍历Form中的所有widget
    
    参数:
    widget - 控件
    gather - 控件集合
    clazz - 控件类型
  - replaceBoundsWidget
```
public static void replaceBoundsWidget(WLayout layout,
                       Widget newWidget)
```
    根据新旧控件的名字替换表单中的控件
    
    参数:
    layout - 外层容器
    newWidget - 新boundswidget
  - getContainer
```
public WLayout getContainer()
```
    获得整个表单容器，即表单最底层容器。
  - setContainer
```
public void setContainer(WLayout container)
```
    设置表单最底层容器。
  - getWidgetByName
```
public Widget getWidgetByName(java.lang.String name)
```
    获取表单中指定名字的控件
    
    指定者:
    
    getWidgetByName 在接口中 FormProvider
    
    指定者:
    
    getWidgetByName 在接口中 BaseFormProvider
    
    参数:
    name - 指定的控件名
    
    返回:
    控件
  - export
```
public boolean export(java.io.OutputStream outputStream)
               throws java.lang.Exception
```
    从类复制的说明: IOFile
    
    将该对象写入指定的输出流中输出
    
    指定者:
    
    export 在接口中 BaseBook
    
    覆盖:
    
    export 在类中 IOFile
    
    参数:
    outputStream - 输出流
    
    返回:
    写入成功则返回true，否则返回false
    
    抛出:
    
    java.lang.Exception - 导出失败异常
  - getWidgetWithBound
```
public Widget getWidgetWithBound(java.lang.String name)
```
    获取表单中指定名字的控件(不对WTitleLayout和WScaleLayout进一步处理)
    
    参数:
    name - 指定的控件名
    
    返回:
    控件
  - getFormMobileAttr
```
public FormMobileAttr getFormMobileAttr()
```
  - setFormMobileAttr
```
public void setFormMobileAttr(FormMobileAttr attr)
```
  - getElementCaseByName
```
public FormElementCaseProvider getElementCaseByName(java.lang.String name)
```
    获取指定名称的报表块, 非控件
    
    指定者:
    
    getElementCaseByName 在接口中 FormProvider
    
    参数:
    name - 指定名称
    
    返回:
    报表块
  - getTemplateParameters
```
public Parameter[] getTemplateParameters()
```
    获取表单存储的参数
    
    返回:
    参数
  - getParameters
```
public Parameter[] getParameters()
```
    获取参数
    
    指定者:
    
    getParameters 在接口中 ParameterHolder
    
    返回:
    参数
  - isNameExist
```
public boolean isNameExist(java.lang.String name)
```
    判断某控件名是否已存在
    
    参数:
    name - 控件名
    
    返回:
    是否存在
  - _renameTableData
```
protected void _renameTableData(java.lang.String oldName,
                    java.lang.String newName)
```
  - renameTableData
```
public void renameTableData(Widget container,
                   java.lang.String oldName,
                   java.lang.String newName)
```
    重命名指定容器内所有widget的数据集
    
    参数:
    oldName - 数据集老的名字
    newName - 数据集新的名字
  - createJSONConfig
```
public JSONObject createJSONConfig(Repository repo,
                          Calculator ca,
                          NodeVisitor nodeVisitor)
                            throws JSONException
```
    生成Form内控件的配置信息。这里分两步，第一步处理控件数据，第二布生成控件配置信息
    
    参数:
    repo - 交互环境变量
    ca - 算子
    nodeVisitor - 节点访问
    
    返回:
    返回配置信息
    
    抛出:
    
    JSONException
  - isFitInBrowser
```
public boolean isFitInBrowser()
```
  - createContentJSONConfig
```
public JSONObject createContentJSONConfig(Repository repo,
                                 Calculator ca)
                                   throws JSONException
```
    生成内容的json配置
    
    参数:
    repo - 环境
    ca - 算子
    
    返回:
    返回内容的json配置
    
    抛出:
    
    JSONException
  - createContentJSONConfig
```
public JSONObject createContentJSONConfig(Repository repo,
                                 Calculator ca,
                                 boolean displayContent)
                                   throws JSONException
```
    生成内容的json配置
    
    参数:
    repo - 环境
    ca - 算子
    displayContent - 是否显示正文内容
    
    返回:
    返回内容的json配置
    
    抛出:
    
    JSONException
  - createParaJSONConfig
```
public JSONObject createParaJSONConfig(Repository repo,
                              Calculator ca)
                                throws JSONException
```
    生成Form中参数界面的json
    
    参数:
    repo - 交互环境变量
    ca - 算子
    
    返回:
    返回参数界面的json(不包含移动端空间列表)
    
    抛出:
    
    JSONException
  - createPara4Mobile
```
public JSONObject createPara4Mobile(Repository repo,
                           TemplateSessionIDInfo sessionIDInfor)
                             throws JSONException
```
    生成Form中参数界面的json
    
    参数:
    repo - 交互环境变量
    sessionIDInfor - 报表session信息
    
    返回:
    返回参数界面的json(包含移动端控件列表)
    
    抛出:
    
    JSONException
  - removeParaLayout
```
public void removeParaLayout()
```
    删除参数面板
  - removeCompInterval
```
public void removeCompInterval()
```
    移除组件边距
  - initWidgetData
```
public boolean initWidgetData(Repository repo,
                     Calculator ca)
```
    处理控件数据, 若发生Exception则返回False
    
    参数:
    repo - 交互环境变量
    ca - 算子
    
    返回:
    返回是否数据处理成功
  - initWidgetData
```
public boolean initWidgetData(Widget widget,
                     Repository repo,
                     Calculator ca)
```
    处理控件数据, 若发生Exception则返回False
    
    参数:
    widget - 指定的控件
    repo - 交互环境变量
    ca - 算子
    
    返回:
    返回是否数据处理成功
  - getWidgetDefaultValueMap
```
public java.util.Map<java.lang.String,java.lang.Object> getWidgetDefaultValueMap()
```
    获取控件默认值的map
    
    指定者:
    
    getWidgetDefaultValueMap 在接口中 FormProvider
    
    指定者:
    
    getWidgetDefaultValueMap 在接口中 BaseFormProvider
    
    返回:
    默认值map
  - getCellValueInElementcase
```
public java.lang.Object getCellValueInElementcase(java.lang.String elementName,
                                         java.lang.String columnRow)
```
    获取指定路径的单元格的值
    
    指定者:
    
    getCellValueInElementcase 在接口中 BaseFormProvider
    
    参数:
    columnRow - 指定行列
    elementName - 指定报表块的名称
    
    返回:
    单元格的值
  - getWidgetDefaultValueMap
```
public java.util.Map<java.lang.String,java.lang.Object> getWidgetDefaultValueMap(java.util.Map<java.lang.String,java.lang.Object> para,
                                                                        Repository repo)
```
    获取控件默认值的map, 如果值已经包含在para中, 那么优先使用para中的如果是公式, 那么用calculator去计算他的结果值.
    
    参数:
    para - 已经计算出来的参数值
    repo - web端一些参数上下文
    
    返回:
    默认值map
  - processDataBinding
```
protected java.lang.Object processDataBinding(Widget widget,
                                  Calculator calculator)
```
  - openTag
```
protected java.lang.String openTag()
```
    Form的IO标示
    
    指定者:
    
    openTag 在类中 IOFile
  - mainContent
```
protected void mainContent(XMLPrintWriter writer)
```
    写Form的主体部分
    
    指定者:
    
    mainContent 在类中 IOFile
    
    参数:
    writer - ： XML写入工具
  - readStream
```
public void readStream(java.io.InputStream in)
                throws java.lang.Exception
```
    从输入流中读取表单
    
    指定者:
    
    readStream 在类中 IOFile
    
    参数:
    in - 输入流
    
    抛出:
    
    java.lang.Exception
  - readXML
```
public void readXML(XMLableReader reader)
```
    read XML
    
    指定者:
    
    readXML 在接口中 XMLReadable
    
    覆盖:
    
    readXML 在类中 AbstractTableDataSource
    
    参数:
    reader - XML读取对象
    另请参阅:
    XMLableReader
  - compatibleOldParameter
```
protected void compatibleOldParameter(XMLableReader reader)
```
  - writeXML
```
public void writeXML(XMLPrintWriter writer)
```
    write XML
    
    指定者:
    
    writeXML 在接口中 XMLWriter
    
    覆盖:
    
    writeXML 在类中 AbstractTableDataSource
    
    参数:
    writer - XML写入对象
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    指定者:
    
    clone 在接口中 FCloneable
    
    覆盖:
    
    clone 在类中 IOFile
    
    返回:
    克隆后的对象
    
    抛出:
    
    java.lang.CloneNotSupportedException - 如果克隆失败则抛出此异常
  - resizeFormElems
```
public void resizeFormElems(java.util.Map<java.lang.String,java.lang.Object> para)
```
  - parseFontFit
```
public boolean parseFontFit(ReportFitAttr fitAttr)
```
  - resizeFormWithBrowser
```
public void resizeFormWithBrowser(java.util.Map<java.lang.String,java.lang.Object> para)
```
  - executeElementCases
```
public void executeElementCases(WidgetSessionIDInfor sessionIDInfo,
                       java.util.Map<java.lang.String,java.lang.Object> para)
```
    计算所有的报表块, 并将结果放入sessionidinfo
    
    参数:
    sessionIDInfo - session会话信息
    para - 参数map
  - getElementCases
```
public ElementCaseEditorProvider[] getElementCases()
```
    获取表单中所有的报表块
    
    指定者:
    
    getElementCases 在接口中 FormProvider
    
    返回:
    报表块集合
  - getAllCharts
```
public BaseChartEditor[] getAllCharts()
```
  - getAllEditedRoleSet
```
public java.lang.String[] getAllEditedRoleSet()
```
    指定者:
    
    getAllEditedRoleSet 在接口中 PrivilegeEditedRoleProvider
  - getReportFitAttr
```
public ReportFitAttr getReportFitAttr()
```
    指定者:
    
    getReportFitAttr 在接口中 FitProvider
  - setReportFitAttr
```
public void setReportFitAttr(ReportFitAttr fitAttr)
```
    指定者:
    
    setReportFitAttr 在接口中 FitProvider
  - addParameter
```
public void addParameter(Parameter parameter)
```
    加入参数
    
    参数:
    parameter - 参数
  - clearParameters
```
public void clearParameters()
```
    清除参数
  - removeParameter
```
public void removeParameter(Parameter parameter)
```
    清除某参数
    
    参数:
    parameter - 参数
  - dealInVisible
```
public void dealInVisible()
                   throws java.lang.Exception
```
    抛出:
    
    java.lang.Exception

类 Form

字段概要

从类继承的字段 com.fr.base.io.IOFile

从类继承的字段 com.fr.data.AbstractTableDataSource

从接口继承的字段 com.fr.data.TableDataSource

构造器概要

方法概要

从类继承的方法 com.fr.base.io.IOFile

从类继承的方法 com.fr.data.AbstractTableDataSource

从类继承的方法 java.lang.Object

从接口继承的方法 com.fr.data.TableDataSource

字段详细资料

FIT

FIT_STATE

PAPER_WHDTH

PAPER_HEIGHT

_SHOWPARA

_SHOWPARATEMPLATE

DEFAULT_FIT

NONE_FIT

fitAttr

parameters

mobileAttr

构造器详细资料

Form

Form

Form

方法详细资料

traversalFormWidget

traversalWidget

replaceBoundsWidget

getContainer

setContainer

getWidgetByName

export

getWidgetWithBound

getFormMobileAttr

setFormMobileAttr

getElementCaseByName

getTemplateParameters

getParameters

isNameExist

_renameTableData

renameTableData

createJSONConfig

isFitInBrowser

createContentJSONConfig

createContentJSONConfig

createParaJSONConfig

createPara4Mobile

removeParaLayout

removeCompInterval

initWidgetData

initWidgetData

getWidgetDefaultValueMap

getCellValueInElementcase

getWidgetDefaultValueMap

processDataBinding

openTag

mainContent

readStream

readXML

compatibleOldParameter

writeXML

clone

resizeFormElems

parseFontFit

resizeFormWithBrowser

executeElementCases

getElementCases

getAllCharts

getAllEditedRoleSet

getReportFitAttr

setReportFitAttr

addParameter

clearParameters

removeParameter

dealInVisible