excel.core
接口 WorkSheet


public interface WorkSheet


方法摘要
 java.lang.String addBackGroundImage(java.lang.String id, java.lang.String url, java.lang.String startCell, java.lang.String endCell, java.lang.String x_position, java.lang.String y_position, java.lang.String x_repeat, java.lang.String y_repeat, int layer, boolean needPrint)
          在指定区域中增加一个背景图片
 void addContextMenu(java.lang.String name, java.lang.String caption)
           
 void addContextMenu(java.lang.String name, java.lang.String caption, java.lang.String parentMenuName)
           
 Cell addExpression(java.lang.String name, java.lang.String expression)
           
 Cell addExpression(java.lang.String name, java.lang.String datasource, java.lang.String dbcol)
           
 void addFocusRange(int startRow, int startCol, int endRow, int endCol)
           
 void balloonTipEdit(java.lang.String dsname, java.lang.String dbcol, int innerRow)
           
 RowCol cellNameToRowColumn(java.lang.String cellName)
           
 Cell cells(int row, int col)
           
 Cell Cells(int row, int col)
           
 Cell cells(java.lang.String cellName)
           
 Cell Cells(java.lang.String cellName)
           
 void clearFocusRange()
          焦点跳转分区
 void copy()
           
 void cut()
           
 void deleteMultiColumn(int startRow, int endRow)
           
 void deleteMultiRow(int startRow, int endRow)
           
 java.lang.Object evaluate(java.lang.String formula)
          评估一个表达式的值
 java.lang.Object evaluate(java.lang.String formula, boolean returnException, java.lang.Object defaultValue)
           
 java.lang.Object evaluate(java.lang.String formula, int innerRow)
           
 java.lang.Object evaluate(java.lang.String formula, int innerRow, boolean returnException, java.lang.Object defaultValue)
           
 void freezeCell(int row, int col)
           
 void freezeCell(java.lang.String cellName)
           
 Brick getBrick(java.lang.String name)
          在本sheet中的单元格中查找指定名称的小控件,如果所有单元格中都不存在指定名称的小控制,则返回null, 如果有多个单元格中都存在指定名称的不控件,则返回第一个小控件,当明确的知道小控制在哪个单元格时,可以使用 sheet.cells(row,col).getBrick(name)来精确查找
 Cell getCellByAlias(java.lang.String alias)
          通过别名查找单元格
 java.lang.Object getCellProperty(int row, int col, java.lang.String propertyName)
           
 java.lang.String getCellText(int row, int col)
           
 java.lang.String getCellText(int row, int col, int cellInnerRow)
           
 java.lang.Object getCellValue(int row, int col)
           
 java.lang.Object getCellValue(int row, int col, int innerRow)
           
 java.lang.String getCode()
           
 int getColumnCount()
           
 boolean getColumnMovePermited()
           
 ColumnPropertyManage getColumnPropertyManage()
           
 CommandManage getCommandManage()
           
 CellPanel getContainerCellPanel()
           
 Range getCurrentFocusRange()
           
 java.lang.String getDataSourceNameAtCurrentMousePoint()
          得到当前鼠标所在点的单元格是否绑定到了数据库
 int getDockPanelPreferredHeight()
           
 int getDockPanelPreferredWidth()
           
 Cell getExpression(java.lang.String name)
           
 int getFloatToTopEndRow()
           
 int getFloatToTopStartRow()
           
 java.util.ArrayList<Range> getFocusRangeList()
           
 Cell getFreezedCell()
           
 java.awt.Color getGridLineColor()
           
 boolean getGridLineVisible()
           
 java.lang.String getGUID()
           
 int getIndex()
           
 java.util.HashMap getMergeMap()
           
 java.lang.String getName()
           
 java.lang.String getPageConfig()
           
 Cell getPageFooter()
           
 Cell getPageHeader()
           
 java.awt.Color getPaperColor()
           
 int getPrintScale()
           
 int getPrintScale(double pageWidth)
           
 java.lang.String getPrintServiceName()
           
 java.lang.Object getRangeProperty(Range range, java.lang.String propertyName)
           
 Row getRow(int row)
           
 int getRowCount()
           
 RowPropertyManage getRowPropertyManage()
           
 Range getSelection()
           
 java.lang.Object getTag()
           
 java.lang.String getTipInfo()
           
 int getViewScale()
           
 WorkBook getWorkBook()
           
 WorkSheetView getWorkSheetView()
           
 int getXOffset()
           
 int getYOffset()
           
 void insertMultiColumn(int startCol, int endCol)
           
 void insertMultiRow(int startRow, int endRow)
           
 void insertWorkSheetToCell(WorkSheet which, Cell toWhere)
           
 void insertWorkSheetToCell(WorkSheet which, Cell toWhere, boolean appendRight, boolean appendBottom)
           
 boolean isBalloonVisible()
           
 boolean isCellNull(int row, int col)
           
 boolean isCellNull(java.lang.String cellName)
           
 boolean isContextMenuEnabled(java.lang.String name)
           
 boolean isDesignMode()
           
 boolean isFormulaBackFillBindEnabled()
           
 boolean isInFirstFocusRange()
           
 boolean isInLastFocusRange()
           
 boolean isOneGroupPrintOnOnePage(int groupLevel)
           
 boolean isPaintPermit()
           
 boolean isPrintable()
           
 boolean isRebuildCellDefineAfterInsertOrDeleteRow()
           
 boolean isTabHighLight()
           
 boolean isVisible()
           
 void Merge(int startRow, int startCol, int endRow, int endCol)
           
 void Merge(Range range)
           
 void moveToFocusRange(int row, int col)
           
 void moveToNextFocusRange()
           
 void moveToPriorFocusRange()
           
 Range newRange(int startRow, int startCol, int endRow, int endCol)
           
 java.util.ArrayList parseDependList(java.lang.String expression)
          解析表达式引用了哪些单元格
 void paste()
           
 void popup(java.lang.String caption, int width, int height, boolean modal, int x, int y, int borderThick, java.awt.Color borderColor)
          弹出显示
 void popup(java.lang.String caption, int width, int height, boolean modal, int x, int y, int borderThick, java.awt.Color borderColor, boolean showTitleBar, boolean showButtonBar)
           
 void popupDispose()
          关闭弹出面板
 Range rangeNameToRange(java.lang.String rangeName)
           
 void reCalculateAllFormula()
          通知所有的公式重新计算 , 在单元格的一些函数比如 setBind ,它们通常需要通知引用自己的单元格 重新计算,当需要多次调用 setBind时,这个通知操作就比较影响性能,所以通常可能关闭通知操作,并 在合适的时候调用本函数来通知所有公式重新计算
 void removeBackgroundImage(java.lang.String id)
           
 void removeContextMenu(java.lang.String name)
           
 boolean removeExpression(java.lang.String name)
           
 boolean removeFocusRange(int startRow, int startCol, int endRow, int endCol)
           
 java.lang.String rowColToName(int row, int col)
           
 boolean save2Image(java.lang.String imgFile)
           
 void setBalloonVisible(boolean v)
           
 void setCellProperty(int row, int col, java.lang.String propertyName, java.lang.Object propertyValue)
           
 void setCellValue(int row, int col, java.lang.Object value)
           
 void setCode(java.lang.String newCode)
           
 void setColumnMovePermited(boolean permited)
           
 void setColumnWidth(int colIndex, int width)
           
 void setContainerCellPanel(CellPanel containerCellPanel)
           
 void setContextMenuEnabled(java.lang.String name, boolean enabled)
           
 void setDockPanelPreferredSize(int width, int height)
           
 void setFloatToTop(int startRow, int endRow)
           
 void setFocusRangeNo(int startRow, int startCol, int endRow, int endCol, int no)
           
 void setFormulaBackFillBindEnabled(boolean auto)
           
 void setGridLineColor(java.awt.Color color)
           
 void setGridLineVisible(boolean v)
           
 void setHeightBetweenTwoRow(int row1, int row2, int delta)
           
 void setIsDesignMode(boolean isDesignMode)
           
 void setName(java.lang.String newname)
           
 void setOneGroupPrintOnOnePage(int groupLevel, boolean b)
           
 void setPageConfig(java.lang.String pageConfig)
           
 void setPaintPermit(boolean paintPermit)
           
 void setPaperColor(java.awt.Color color)
           
 void setPrintable(boolean b)
           
 void setPrintScale(int scale)
           
 void setPrintServiceName(java.lang.String printServiceName)
           
 void setRangeBorder(int startRow, int startCol, int endRow, int endCol, int whichSide, int style, int width, java.lang.String color)
           
 void setRangeBorder(Range range, int whichSide, int style, int width, java.awt.Color color)
           
 void setRangeBorder(Range range, int whichSide, int style, int width, java.lang.String color)
           
 void setRangeProperty(Range range, java.lang.String propertyName, java.lang.Object propertyValue)
           
 void setRebuildCellDefineAfterInsertOrDeleteRow(boolean b)
           
 void setRowHeight(int rowIndex, int height)
           
 void setSelection(Cell cell)
           
 void setSelection(Cell fromCell, Cell toCell)
           
 void setSelection(int startRow, int startCol, int endRow, int endCol)
           
 void setSelection(Range r)
           
 void setTabHighLight(boolean b)
           
 void setTag(java.lang.Object tag)
          提供一个附加数据
 void setTipInfo(java.lang.String info)
           
 void setViewScale(int scale)
           
 void setVisible(boolean visible)
           
 void setWidthBetweenTwoColumn(int col1, int col2, int delta)
           
 void setWorkSheetView(WorkSheetView view)
           
 void setXOffset(int xoffset)
           
 void setYOffset(int yoffset)
           
 void showOnDockPanel(java.lang.String where, int width, int height)
           
 void showPopupMenu(java.lang.String menuConfig)
           
 void unFreezeCell()
           
 void UnMerge(int startRow, int startCol, int endRow, int endCol)
           
 void UnMerge(Range range)
           
 

方法详细信息

getName

java.lang.String getName()

setName

void setName(java.lang.String newname)

getGUID

java.lang.String getGUID()

getCode

java.lang.String getCode()

setCode

void setCode(java.lang.String newCode)

getWorkBook

WorkBook getWorkBook()

getCommandManage

CommandManage getCommandManage()

getWorkSheetView

WorkSheetView getWorkSheetView()

setWorkSheetView

void setWorkSheetView(WorkSheetView view)

getIndex

int getIndex()

setPaperColor

void setPaperColor(java.awt.Color color)

getPaperColor

java.awt.Color getPaperColor()

isPaintPermit

boolean isPaintPermit()

setPaintPermit

void setPaintPermit(boolean paintPermit)

setGridLineColor

void setGridLineColor(java.awt.Color color)

getGridLineColor

java.awt.Color getGridLineColor()

setGridLineVisible

void setGridLineVisible(boolean v)

getGridLineVisible

boolean getGridLineVisible()

getXOffset

int getXOffset()

setXOffset

void setXOffset(int xoffset)

getYOffset

int getYOffset()

setYOffset

void setYOffset(int yoffset)

getColumnPropertyManage

ColumnPropertyManage getColumnPropertyManage()

getRowPropertyManage

RowPropertyManage getRowPropertyManage()

getColumnMovePermited

boolean getColumnMovePermited()

setColumnMovePermited

void setColumnMovePermited(boolean permited)

Cells

Cell Cells(int row,
           int col)

Cells

Cell Cells(java.lang.String cellName)

cells

Cell cells(int row,
           int col)

cells

Cell cells(java.lang.String cellName)

getCellByAlias

Cell getCellByAlias(java.lang.String alias)
通过别名查找单元格

参数:
alias -
返回:

isCellNull

boolean isCellNull(int row,
                   int col)

isCellNull

boolean isCellNull(java.lang.String cellName)

getRowCount

int getRowCount()

getColumnCount

int getColumnCount()

getSelection

Range getSelection()

setSelection

void setSelection(Range r)

setSelection

void setSelection(int startRow,
                  int startCol,
                  int endRow,
                  int endCol)

setSelection

void setSelection(Cell cell)

setSelection

void setSelection(Cell fromCell,
                  Cell toCell)

setCellValue

void setCellValue(int row,
                  int col,
                  java.lang.Object value)

getCellValue

java.lang.Object getCellValue(int row,
                              int col)

getCellValue

java.lang.Object getCellValue(int row,
                              int col,
                              int innerRow)

getCellText

java.lang.String getCellText(int row,
                             int col,
                             int cellInnerRow)

getCellText

java.lang.String getCellText(int row,
                             int col)

newRange

Range newRange(int startRow,
               int startCol,
               int endRow,
               int endCol)

setCellProperty

void setCellProperty(int row,
                     int col,
                     java.lang.String propertyName,
                     java.lang.Object propertyValue)

getCellProperty

java.lang.Object getCellProperty(int row,
                                 int col,
                                 java.lang.String propertyName)

setRangeProperty

void setRangeProperty(Range range,
                      java.lang.String propertyName,
                      java.lang.Object propertyValue)

getRangeProperty

java.lang.Object getRangeProperty(Range range,
                                  java.lang.String propertyName)

setRangeBorder

void setRangeBorder(int startRow,
                    int startCol,
                    int endRow,
                    int endCol,
                    int whichSide,
                    int style,
                    int width,
                    java.lang.String color)

setRangeBorder

void setRangeBorder(Range range,
                    int whichSide,
                    int style,
                    int width,
                    java.lang.String color)

setRangeBorder

void setRangeBorder(Range range,
                    int whichSide,
                    int style,
                    int width,
                    java.awt.Color color)

Merge

void Merge(int startRow,
           int startCol,
           int endRow,
           int endCol)

Merge

void Merge(Range range)

UnMerge

void UnMerge(int startRow,
             int startCol,
             int endRow,
             int endCol)

UnMerge

void UnMerge(Range range)

setColumnWidth

void setColumnWidth(int colIndex,
                    int width)

setWidthBetweenTwoColumn

void setWidthBetweenTwoColumn(int col1,
                              int col2,
                              int delta)

setRowHeight

void setRowHeight(int rowIndex,
                  int height)

setHeightBetweenTwoRow

void setHeightBetweenTwoRow(int row1,
                            int row2,
                            int delta)

getMergeMap

java.util.HashMap getMergeMap()

isDesignMode

boolean isDesignMode()

setIsDesignMode

void setIsDesignMode(boolean isDesignMode)

insertMultiRow

void insertMultiRow(int startRow,
                    int endRow)

insertMultiColumn

void insertMultiColumn(int startCol,
                       int endCol)

deleteMultiRow

void deleteMultiRow(int startRow,
                    int endRow)

deleteMultiColumn

void deleteMultiColumn(int startRow,
                       int endRow)

getRow

Row getRow(int row)

freezeCell

void freezeCell(int row,
                int col)

freezeCell

void freezeCell(java.lang.String cellName)

getFreezedCell

Cell getFreezedCell()

unFreezeCell

void unFreezeCell()

cut

void cut()

copy

void copy()

paste

void paste()

setPrintScale

void setPrintScale(int scale)

getPrintScale

int getPrintScale()

getPrintScale

int getPrintScale(double pageWidth)

getPrintServiceName

java.lang.String getPrintServiceName()

setPrintServiceName

void setPrintServiceName(java.lang.String printServiceName)

getPageConfig

java.lang.String getPageConfig()

setPageConfig

void setPageConfig(java.lang.String pageConfig)

evaluate

java.lang.Object evaluate(java.lang.String formula)
评估一个表达式的值

参数:
formula -
返回:

evaluate

java.lang.Object evaluate(java.lang.String formula,
                          boolean returnException,
                          java.lang.Object defaultValue)

evaluate

java.lang.Object evaluate(java.lang.String formula,
                          int innerRow)

evaluate

java.lang.Object evaluate(java.lang.String formula,
                          int innerRow,
                          boolean returnException,
                          java.lang.Object defaultValue)

setVisible

void setVisible(boolean visible)

isVisible

boolean isVisible()

setTabHighLight

void setTabHighLight(boolean b)

isTabHighLight

boolean isTabHighLight()

setFormulaBackFillBindEnabled

void setFormulaBackFillBindEnabled(boolean auto)

isFormulaBackFillBindEnabled

boolean isFormulaBackFillBindEnabled()

reCalculateAllFormula

void reCalculateAllFormula()
通知所有的公式重新计算 , 在单元格的一些函数比如 setBind ,它们通常需要通知引用自己的单元格 重新计算,当需要多次调用 setBind时,这个通知操作就比较影响性能,所以通常可能关闭通知操作,并 在合适的时候调用本函数来通知所有公式重新计算


clearFocusRange

void clearFocusRange()
焦点跳转分区


getFocusRangeList

java.util.ArrayList<Range> getFocusRangeList()

addFocusRange

void addFocusRange(int startRow,
                   int startCol,
                   int endRow,
                   int endCol)

removeFocusRange

boolean removeFocusRange(int startRow,
                         int startCol,
                         int endRow,
                         int endCol)

setFocusRangeNo

void setFocusRangeNo(int startRow,
                     int startCol,
                     int endRow,
                     int endCol,
                     int no)

getCurrentFocusRange

Range getCurrentFocusRange()

moveToFocusRange

void moveToFocusRange(int row,
                      int col)

moveToNextFocusRange

void moveToNextFocusRange()

moveToPriorFocusRange

void moveToPriorFocusRange()

isInLastFocusRange

boolean isInLastFocusRange()

isInFirstFocusRange

boolean isInFirstFocusRange()

setTag

void setTag(java.lang.Object tag)
提供一个附加数据

参数:
tag -

getTag

java.lang.Object getTag()

parseDependList

java.util.ArrayList parseDependList(java.lang.String expression)
解析表达式引用了哪些单元格


rowColToName

java.lang.String rowColToName(int row,
                              int col)

cellNameToRowColumn

RowCol cellNameToRowColumn(java.lang.String cellName)

rangeNameToRange

Range rangeNameToRange(java.lang.String rangeName)

addBackGroundImage

java.lang.String addBackGroundImage(java.lang.String id,
                                    java.lang.String url,
                                    java.lang.String startCell,
                                    java.lang.String endCell,
                                    java.lang.String x_position,
                                    java.lang.String y_position,
                                    java.lang.String x_repeat,
                                    java.lang.String y_repeat,
                                    int layer,
                                    boolean needPrint)
在指定区域中增加一个背景图片

参数:
id - 图片的ID ,每个工作表单上背景图片都需要指定一个唯一的ID,这个ID可以是任意的字符串
url - 图片所在的地址,可以是如下几种类型:
  • 客户机上的绝对路径。比如 "file:///c:/temp/a.jpg"
  • 服务器上的相对路径。比如:"/upload/a.jpg""
  • 互联网上的绝对路径。比如:"http://www.53oa.com/image/logo.jpg"
startCell - 单元格名称或别名,表示背景放置的起始位置
endCell - 单元格名称或别名,表示背景放置的结束位置,如果为 "" 表示背景一直绘制到控件的右下角
x_position - 相对起始单元格的X方向的坐标。它可以是如下类型:
  • 一个数字:表示相对于起始单元格左上角的X方向上的距离,单位是像素,比如:50
  • 一个界于 0到 99%的百分比字符串,比如 : "50%" ,表示在X方向上50%距离处开始绘制背景
  • 表示对齐方式的字符串,比如: "left", "center","right" 表示在X方向上绘制时的对齐方式
y_position - 相对起始单元格的Y方向的坐标。它可以是如下类型:
  • 一个数字:表示相对于起始单元格左上角的Y方向上的距离,单位是像素,比如:50
  • 一个界于 0到 99%的百分比字符串,比如 : "50%" ,表示在Y方向上50%距离处开始绘制背景
  • 表示对齐方式的字符串,比如: "top", "center","bottom" 表示在Y方向上绘制时的对齐方式
x_repeat - 在水平方向上重复绘制的方式。它可以是:
  • "" :空字符串,表示只绘制一次
  • "repeat" :表示水平方向上进行重复绘制
y_repeat - 在垂直方向上重复绘制的方式。它可以是:
  • "" :空字符串,表示只绘制一次
  • "repeat" :表示垂直方向上进行重复绘制
layer - 一个数字,用来表示该背景的层次关系,数字越大的,表示在上层,数字越小的,表示在下层
needPrint - boolean型,true表示在打印时需要绘制,false表示在打印时不绘制
返回:
返回 "" 表示增加背景成功。否则返回错误提示信息。

removeBackgroundImage

void removeBackgroundImage(java.lang.String id)

getBrick

Brick getBrick(java.lang.String name)
在本sheet中的单元格中查找指定名称的小控件,如果所有单元格中都不存在指定名称的小控制,则返回null, 如果有多个单元格中都存在指定名称的不控件,则返回第一个小控件,当明确的知道小控制在哪个单元格时,可以使用 sheet.cells(row,col).getBrick(name)来精确查找

参数:
name -
返回:

addContextMenu

void addContextMenu(java.lang.String name,
                    java.lang.String caption)

addContextMenu

void addContextMenu(java.lang.String name,
                    java.lang.String caption,
                    java.lang.String parentMenuName)

removeContextMenu

void removeContextMenu(java.lang.String name)

setContextMenuEnabled

void setContextMenuEnabled(java.lang.String name,
                           boolean enabled)

isContextMenuEnabled

boolean isContextMenuEnabled(java.lang.String name)

setTipInfo

void setTipInfo(java.lang.String info)

getTipInfo

java.lang.String getTipInfo()

addExpression

Cell addExpression(java.lang.String name,
                   java.lang.String expression)

addExpression

Cell addExpression(java.lang.String name,
                   java.lang.String datasource,
                   java.lang.String dbcol)

removeExpression

boolean removeExpression(java.lang.String name)

getExpression

Cell getExpression(java.lang.String name)

setPrintable

void setPrintable(boolean b)

isPrintable

boolean isPrintable()

setRebuildCellDefineAfterInsertOrDeleteRow

void setRebuildCellDefineAfterInsertOrDeleteRow(boolean b)

isRebuildCellDefineAfterInsertOrDeleteRow

boolean isRebuildCellDefineAfterInsertOrDeleteRow()

getPageHeader

Cell getPageHeader()

getPageFooter

Cell getPageFooter()

setFloatToTop

void setFloatToTop(int startRow,
                   int endRow)

getFloatToTopStartRow

int getFloatToTopStartRow()

getFloatToTopEndRow

int getFloatToTopEndRow()

getDataSourceNameAtCurrentMousePoint

java.lang.String getDataSourceNameAtCurrentMousePoint()
得到当前鼠标所在点的单元格是否绑定到了数据库

返回:

insertWorkSheetToCell

void insertWorkSheetToCell(WorkSheet which,
                           Cell toWhere)

insertWorkSheetToCell

void insertWorkSheetToCell(WorkSheet which,
                           Cell toWhere,
                           boolean appendRight,
                           boolean appendBottom)

getContainerCellPanel

CellPanel getContainerCellPanel()

setContainerCellPanel

void setContainerCellPanel(CellPanel containerCellPanel)

popup

void popup(java.lang.String caption,
           int width,
           int height,
           boolean modal,
           int x,
           int y,
           int borderThick,
           java.awt.Color borderColor)
弹出显示

参数:
caption -
width -
height -
modal -
x -
y -
borderThick -
borderColor -

popup

void popup(java.lang.String caption,
           int width,
           int height,
           boolean modal,
           int x,
           int y,
           int borderThick,
           java.awt.Color borderColor,
           boolean showTitleBar,
           boolean showButtonBar)

popupDispose

void popupDispose()
关闭弹出面板


showOnDockPanel

void showOnDockPanel(java.lang.String where,
                     int width,
                     int height)

setDockPanelPreferredSize

void setDockPanelPreferredSize(int width,
                               int height)

getDockPanelPreferredWidth

int getDockPanelPreferredWidth()

getDockPanelPreferredHeight

int getDockPanelPreferredHeight()

isOneGroupPrintOnOnePage

boolean isOneGroupPrintOnOnePage(int groupLevel)

setOneGroupPrintOnOnePage

void setOneGroupPrintOnOnePage(int groupLevel,
                               boolean b)

setViewScale

void setViewScale(int scale)

getViewScale

int getViewScale()

setBalloonVisible

void setBalloonVisible(boolean v)

isBalloonVisible

boolean isBalloonVisible()

balloonTipEdit

void balloonTipEdit(java.lang.String dsname,
                    java.lang.String dbcol,
                    int innerRow)

showPopupMenu

void showPopupMenu(java.lang.String menuConfig)

save2Image

boolean save2Image(java.lang.String imgFile)