Change Cell's Style and Text Format"
m (→Font family) |
m (correct highlight (via JWB)) |
||
(81 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{ZKSpreadsheetEssentialsPageHeader}} | {{ZKSpreadsheetEssentialsPageHeader}} | ||
+ | |||
+ | {{Deprecated|url=http://books.zkoss.org/wiki/ZK_Spreadsheet_Essentials}} | ||
+ | |||
+ | |||
__TOC__ | __TOC__ | ||
+ | |||
+ | ===Purpose=== | ||
+ | ZK Spreadsheet supports various cell style and font style. | ||
{| border="1" | {| border="1" | ||
Line 11: | Line 18: | ||
||Border / Border Color || Cause of browser limitation, only solid/dashed/dotted border are supported now. | ||Border / Border Color || Cause of browser limitation, only solid/dashed/dotted border are supported now. | ||
|- | |- | ||
− | || | + | ||Alignment || Horizontal, Vertical Alignment |
|- | |- | ||
||Text Wrap & Overflow || | ||Text Wrap & Overflow || | ||
|- | |- | ||
− | || | + | || Merged Cell || Horizontal/Vertical Merged Cell |
+ | |- | ||
+ | || Data Formats || Format cell | ||
|} | |} | ||
+ | ===Clone Cell Style=== | ||
+ | To keep original cell style and only modify part of style, we can use the <javadoc directory="zss" method="cloneStyleFrom(org.zkoss.poi.ss.usermodel.CellStyle)">org.zkoss.poi.ss.usermodel.CellStyle</javadoc> to clone a cell style. | ||
− | + | <source lang="java" highlight="2,3"> | |
− | |||
− | |||
− | <source lang="java" | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | 2 | ||
− | |||
− | |||
CellStyle cloneStyle(CellStyle srcStyle, Book book) { | CellStyle cloneStyle(CellStyle srcStyle, Book book) { | ||
CellStyle newStyle = book.createCellStyle(); | CellStyle newStyle = book.createCellStyle(); | ||
Line 43: | Line 40: | ||
===Cell Style=== | ===Cell Style=== | ||
====Color==== | ====Color==== | ||
− | We | + | We get color from <javadoc directory="zss" method="getFillForegroundColorColor()">org.zkoss.poi.ss.usermodel.CellStyle</javadoc>. |
− | After we clone cell style, we can modify color by | + | After we clone cell style, we can modify color by <javadoc directory="zss" method="setFillForegroundColor(java.lang.Short)">org.zkoss.poi.ss.usermodel.CellStyle</javadoc>, and use <javadoc directory="zss" method="setStyle(org.zkoss.poi.ss.usermodel.CellStyle)">org.zkoss.zss.model.Range</javadoc> to set new style |
− | <source lang="java" > | + | <source lang="java" highlight="5,11,16,17"> |
− | void setCellColor(String color) { | + | public void setCellColor(String color) { |
− | + | Rect rect = getSelection(); | |
− | + | Worksheet sheet = spreadsheet.getSelectedSheet(); | |
− | + | Book book = spreadsheet.getBook(); | |
− | + | final Color newColor = BookHelper.HTMLToColor(book, color); | |
− | + | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | |
− | + | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | |
− | + | Cell cell = Utils.getOrCreateCell(sheet, row, col); | |
− | + | CellStyle cellStyle = cell.getCellStyle(); | |
− | + | final Color srcColor = cellStyle.getFillForegroundColorColor(); | |
− | + | if (!Objects.equals(newColor, srcColor)) { | |
− | + | CellStyle newStyle = cloneStyle(cellStyle, book); | |
− | + | newStyle.cloneStyleFrom(cellStyle); | |
− | + | BookHelper.setFillForegroundColor(newStyle, newColor);//use CellStyle.setFillForegroundColor | |
− | + | Ranges.range(sheet, row, col).setStyle(newStyle); | |
− | |||
− | |||
} | } | ||
} | } | ||
} | } | ||
+ | } | ||
</source> | </source> | ||
+ | |||
====Alignment==== | ====Alignment==== | ||
− | We can get cell's alignment information by | + | =====Horizontal alignment===== |
+ | We can get the cell's horizontal alignment information by <javadoc directory="zss" method="getAlignment()">org.zkoss.poi.ss.usermodel.CellStyle</javadoc>, and use <javadoc directory="zss" method="setAlignment(java.lang.Short)">org.zkoss.poi.ss.usermodel.CellStyle</javadoc> to set horizontal alignment. | ||
− | <source lang="java" > | + | <source lang="java" highlight="9,12,13"> |
− | + | public void setAlignment(short alignment) { | |
− | + | Rect rect = getSelection(); | |
− | + | Worksheet sheet = spreadsheet.getSelectedSheet(); | |
− | + | Book book = spreadsheet.getBook(); | |
− | + | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | |
− | + | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | |
− | + | Cell cell = Utils.getOrCreateCell(sheet, row, col); | |
− | + | short srcAlign = cell.getCellStyle().getAlignment(); | |
− | + | if (srcAlign != alignment) { | |
− | + | CellStyle newStyle = cloneStyle(cell.getCellStyle(), book); | |
− | + | newStyle.setAlignment(alignment); | |
− | + | Ranges.range(sheet, row, col).setStyle(newStyle); | |
− | |||
− | |||
} | } | ||
} | } | ||
} | } | ||
+ | } | ||
</source> | </source> | ||
− | ==== | + | =====VerticalAlignment alignment===== |
+ | We can get the cell's vertical alignment information by <javadoc directory="zss" method="getVerticalAlignment()">org.zkoss.poi.ss.usermodel.CellStyle</javadoc>, and use <javadoc directory="zss" method="setVerticalAlignment(java.lang.Short)">org.zkoss.poi.ss.usermodel.CellStyle</javadoc> to set vertical alignment. | ||
− | + | <source lang="java" highlight="9,12,13"> | |
− | + | public void setVerticalAlignment(short alignment) { | |
− | + | Rect rect = getSelection(); | |
+ | Worksheet sheet = spreadsheet.getSelectedSheet(); | ||
+ | Book book = spreadsheet.getBook(); | ||
+ | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | ||
+ | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | ||
− | + | Cell cell = Utils.getOrCreateCell(sheet, row, col); | |
− | + | short srcAlign = cell.getCellStyle().getVerticalAlignment(); | |
+ | if (srcAlign != alignment) { | ||
+ | CellStyle newStyle = cloneStyle(cell.getCellStyle(), book); | ||
+ | newStyle.setVerticalAlignment(alignment); | ||
+ | Ranges.range(sheet, row, col).setStyle(newStyle); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
− | + | ====Border==== | |
− | |||
− | < | + | We can set the border by <javadoc directory="zss" method="setBorders(java.lang.Short, org.zkoss.poi.ss.usermodel.BorderStyle, java.lang.String)">org.zkoss.zss.model.Range</javadoc> |
− | / | ||
− | |||
− | //Border style | + | <source lang="java" highlight="3,5,"> |
− | BorderStyle style = "none".equals(border) ? BorderStyle.NONE : BorderStyle.MEDIUM; | + | void setBorder(String border) { |
+ | //Border color | ||
+ | String color = "#000000"; | ||
+ | //Border style | ||
+ | BorderStyle style = "none".equals(border) ? BorderStyle.NONE : BorderStyle.MEDIUM; | ||
− | Rect rect = getSelection(); | + | Rect rect = getSelection(); |
− | + | Worksheet sheet = spreadsheet.getSelectedSheet(); | |
− | int lCol = rect.getLeft(); | + | int lCol = rect.getLeft(); |
− | int rCol = rect.getRight(); | + | int rCol = rect.getRight(); |
− | int tRow = rect.getTop(); | + | int tRow = rect.getTop(); |
− | int bRow = rect.getBottom(); | + | int bRow = rect.getBottom(); |
− | if ("bottom".equals(border)) { | + | if ("bottom".equals(border)) { |
− | + | Ranges.range(sheet, tRow, lCol, bRow, rCol). | |
− | + | setBorders(BookHelper.BORDER_EDGE_BOTTOM, style, color); | |
− | } else if ("top".equals(border)) { | + | } else if ("top".equals(border)) { |
− | + | Ranges.range(sheet, tRow, lCol, tRow, rCol). | |
− | + | setBorders(BookHelper.BORDER_EDGE_TOP, style, color); | |
− | } else if ("left".equals(border)) { | + | } else if ("left".equals(border)) { |
− | + | Ranges.range(sheet, tRow, lCol, bRow, lCol). | |
− | + | setBorders(BookHelper.BORDER_EDGE_LEFT, style, color); | |
− | } else if ("right".equals(border)) { | + | } else if ("right".equals(border)) { |
− | + | Ranges.range(sheet, tRow, rCol, bRow, rCol). | |
− | + | setBorders(BookHelper.BORDER_EDGE_RIGHT, style, color); | |
− | } else if ("none".equals(border)) { | + | } else if ("none".equals(border)) { |
− | + | Ranges.range(sheet, tRow, lCol, bRow, rCol). | |
− | + | setBorders(BookHelper.BORDER_FULL, style, color); | |
− | } else if ("full".equals(border)) { | + | } else if ("full".equals(border)) { |
− | + | Ranges.range(sheet, tRow, lCol, bRow, rCol). | |
− | + | setBorders(BookHelper.BORDER_FULL, style, color); | |
+ | } | ||
} | } | ||
</source> | </source> | ||
Line 143: | Line 156: | ||
===Font Style=== | ===Font Style=== | ||
− | From | + | From <javadoc directory="zss" method="getFontIndex()">org.zkoss.poi.ss.usermodel.CellStyle</javadoc>, we get font index in the book, then we can get Font from Book.getFontAt() <javadoc directory="zss" method="getFontAt(java.lang.String)">org.zkoss.zss.model.Book</javadoc> |
− | We can create Font by | + | We can get or create Font by <javadoc directory="zss" method="getOrCreateFont(org.zkoss.zss.model.Book, java.lang.Sort, org.zkoss.poi.ss.usermodel.Color, java.lang.Short, java.lang.String, java.lang.Boolean, java.lang.Boolean, java.lang.Short, java.lang.Byte)">org.zkoss.zss.model.impl.BookHelper</javadoc> |
====Font family==== | ====Font family==== | ||
− | <source lang="java" > | + | <source lang="java" highlight="8,11, 17,18"> |
void setFontFamily(String fontName) { | void setFontFamily(String fontName) { | ||
Rect rect = getSelection(); | Rect rect = getSelection(); | ||
− | + | Worksheet sheet = spreadsheet.getSelectedSheet(); | |
Book book = spreadsheet.getBook(); | Book book = spreadsheet.getBook(); | ||
for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | ||
Line 159: | Line 172: | ||
if (srcFont.getFontName() != fontName) { | if (srcFont.getFontName() != fontName) { | ||
− | Font newFont = | + | Font newFont = BookHelper.getOrCreateFont(book, |
− | BookHelper.getOrCreateFont(book, srcFont.getBoldweight(), BookHelper.getFontColor(book, srcFont), | + | srcFont.getBoldweight(), BookHelper.getFontColor(book, srcFont), |
− | Font.getFontHeight(), fontName, | + | Font.getFontHeight(), fontName, srcFont.getItalic(), srcFont.getStrikeout(), |
srcFont.getTypeOffset(), srcFont.getUnderline()); | srcFont.getTypeOffset(), srcFont.getUnderline()); | ||
CellStyle newStyle = cloneStyle(cell.getCellStyle(), book); | CellStyle newStyle = cloneStyle(cell.getCellStyle(), book); | ||
− | newStyle.setFont(newFont); | + | newStyle.setFont(newFont); |
− | |||
Ranges.range(sheet, row, col).setStyle(newStyle); | Ranges.range(sheet, row, col).setStyle(newStyle); | ||
} | } | ||
Line 175: | Line 187: | ||
====Font size==== | ====Font size==== | ||
+ | |||
+ | We can get the font height by using <javadoc directory="zss" method="getFontHeight()">org.zkoss.poi.ss.usermodel.Font</javadoc> , however the font size is different from the font height. The font height in unit's of 1/20th of a point, so we can transform the font size to the font height by | ||
+ | <source lang="java" highlight="2"> | ||
+ | short getFontHeight(int fontSize) { | ||
+ | return (short) (fontSize * 20); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | After we get the font height to set, we can use <javadoc directory="zss" method="getOrCreateFont(org.zkoss.zss.model.Book, java.lang.Sort, org.zkoss.poi.ss.usermodel.Color, java.lang.Short, java.lang.String, java.lang.Boolean, java.lang.Boolean, java.lang.Short, java.lang.Byte)">org.zkoss.zss.model.impl.BookHelper</javadoc>. | ||
+ | |||
+ | <source lang="java" highlight="9,11, 16,17"> | ||
+ | void setFontSize(short fontHeight) { | ||
+ | Rect rect = getSelection(); | ||
+ | Worksheet sheet = spreadsheet.getSelectedSheet(); | ||
+ | Book book = spreadsheet.getBook(); | ||
+ | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | ||
+ | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | ||
+ | Cell cell = Utils.getOrCreateCell(sheet, row, col); | ||
+ | |||
+ | Font srcFont = book.getFontAt(cell.getCellStyle().getFontIndex()); | ||
+ | if (srcFont.getFontHeight() != fontHeight) { | ||
+ | Font newFont = BookHelper.getOrCreateFont(book, srcFont.getBoldweight(), | ||
+ | BookHelper.getFontColor(book, srcFont), fontHeight, srcFont.getFontName(), | ||
+ | srcFont.getItalic(), srcFont.getStrikeout(), srcFont.getTypeOffset(), srcFont.getUnderline()); | ||
+ | |||
+ | CellStyle newStyle = cloneStyle(cell.getCellStyle(), book); | ||
+ | newStyle.setFont(newFont); | ||
+ | Ranges.range(sheet, row, col).setStyle(newStyle); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
====Bold==== | ====Bold==== | ||
+ | |||
+ | We can get the font bold weight by employing <javadoc directory="zss" method="getBoldweight()">org.zkoss.poi.ss.usermodel.Font</javadoc> | ||
+ | <source lang="java" highlight="11,13,20,21"> | ||
+ | void setFontBold(boolean isBold) { | ||
+ | Rect rect = getSelection(); | ||
+ | Worksheet sheet = spreadsheet.getSelectedSheet(); | ||
+ | Book book = spreadsheet.getBook(); | ||
+ | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | ||
+ | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | ||
+ | Cell cell = Utils.getOrCreateCell(sheet, row, col); | ||
+ | Font srcFont = book.getFontAt( | ||
+ | cell.getCellStyle().getFontIndex()); | ||
+ | |||
+ | boolean srcBold = srcFont.getBoldweight() == Font.BOLDWEIGHT_BOLD; | ||
+ | if (srcBold != isBold) { | ||
+ | Font newFont = BookHelper.getOrCreateFont(book, | ||
+ | isBold ? Font.BOLDWEIGHT_BOLD : Font.BOLDWEIGHT_NORMAL, | ||
+ | BookHelper.getFontColor(book, srcFont), srcFont.getFontHeight(), | ||
+ | srcFont.getFontName(), srcFont.getItalic(), srcFont.getStrikeout(), | ||
+ | srcFont.getTypeOffset(), srcFont.getUnderline()); | ||
+ | |||
+ | CellStyle newStyle = cloneStyle(cell.getCellStyle(), book); | ||
+ | newStyle.setFont(newFont); | ||
+ | Ranges.range(sheet, row, col).setStyle(newStyle); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
+ | |||
====Italic==== | ====Italic==== | ||
+ | |||
+ | We can know whether the font uses italic or not by <javadoc directory="zss" method="getItalic()">org.zkoss.poi.ss.usermodel.Font</javadoc> | ||
+ | <source lang="java" highlight="11,13,19,20"> | ||
+ | void setItalic(boolean isItalic) { | ||
+ | Rect rect = getSelection(); | ||
+ | Worksheet sheet = spreadsheet.getSelectedSheet(); | ||
+ | Book book = spreadsheet.getBook(); | ||
+ | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | ||
+ | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | ||
+ | Cell cell = Utils.getOrCreateCell(sheet, row, col); | ||
+ | Font srcFont = book.getFontAt( | ||
+ | cell.getCellStyle().getFontIndex()); | ||
+ | |||
+ | boolean srcItalic = srcFont.getItalic(); | ||
+ | if (srcItalic != isItalic) { | ||
+ | Font newFont = BookHelper.getOrCreateFont(book, | ||
+ | srcFont.getBoldweight(), BookHelper.getFontColor(book, srcFont), | ||
+ | srcFont.getFontHeight(), srcFont.getFontName(), isItalic, | ||
+ | srcFont.getStrikeout(), srcFont.getTypeOffset(), srcFont.getUnderline()); | ||
+ | |||
+ | CellStyle newStyle = cloneStyle(cell.getCellStyle(), book); | ||
+ | newStyle.setFont(newFont); | ||
+ | Ranges.range(sheet, row, col).setStyle(newStyle); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
+ | |||
====Underline==== | ====Underline==== | ||
+ | |||
+ | We can get the font underline information by using <javadoc directory="zss" method="getUnderline()">org.zkoss.poi.ss.usermodel.Font</javadoc> | ||
+ | |||
+ | <source lang="java" highlight="12,14,20,21"> | ||
+ | void setUnderline(boolean isUnderline){ | ||
+ | Rect rect = getSelection(); | ||
+ | Worksheet sheet = spreadsheet.getSelectedSheet(); | ||
+ | Book book = spreadsheet.getBook(); | ||
+ | |||
+ | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | ||
+ | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | ||
+ | Cell cell = Utils.getOrCreateCell(sheet, row, col); | ||
+ | Font srcFont = book.getFontAt( | ||
+ | cell.getCellStyle().getFontIndex()); | ||
+ | |||
+ | boolean srcUnderline = srcFont.getUnderline() == Font.U_SINGLE; | ||
+ | if (srcUnderline != isUnderline) { | ||
+ | Font newFont = BookHelper.getOrCreateFont(book, srcFont.getBoldweight(), | ||
+ | BookHelper.getFontColor(book, srcFont), srcFont.getFontHeight(), | ||
+ | srcFont.getFontName(), srcFont.getItalic(), srcFont.getStrikeout(), | ||
+ | srcFont.getTypeOffset(), isUnderline ? Font.U_SINGLE : Font.U_NONE); | ||
+ | |||
+ | CellStyle newStyle = cloneStyle(cell.getCellStyle(), book); | ||
+ | newStyle.setFont(newFont); | ||
+ | Ranges.range(sheet, row, col).setStyle(newStyle); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
+ | |||
====Strikethrough==== | ====Strikethrough==== | ||
+ | We can know whether the font uses strikethrough or not by <javadoc directory="zss" method="getStrikeout()">org.zkoss.poi.ss.usermodel.Font</javadoc> | ||
+ | <source lang="java" highlight="12,14,20,21"> | ||
+ | void setStrikethrough(boolean isStrikethrough) { | ||
+ | Rect rect = getSelection(); | ||
+ | Worksheet sheet = spreadsheet.getSelectedSheet(); | ||
+ | Book book = spreadsheet.getBook(); | ||
+ | |||
+ | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | ||
+ | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | ||
+ | Cell cell = Utils.getOrCreateCell(sheet, row, col); | ||
+ | Font srcFont = book.getFontAt( | ||
+ | cell.getCellStyle().getFontIndex()); | ||
+ | |||
+ | boolean srcStrikethrough = srcFont.getStrikeout(); | ||
+ | if (srcStrikethrough != isStrikethrough) { | ||
+ | Font newFont = BookHelper.getOrCreateFont(book, srcFont.getBoldweight(), | ||
+ | BookHelper.getFontColor(book, srcFont), srcFont.getFontHeight(), | ||
+ | srcFont.getFontName(), srcFont.getItalic(), isStrikethrough, | ||
+ | srcFont.getTypeOffset(), srcFont.getUnderline()); | ||
+ | |||
+ | CellStyle newStyle = cloneStyle(cell.getCellStyle(), book); | ||
+ | newStyle.setFont(newFont); | ||
+ | Ranges.range(sheet, row, col).setStyle(newStyle); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ===Data Format=== | ||
+ | Get data format using <code>CellStyle.getDataFormat()</code> and set new data format using <code>CellStyle.setDataFormat(format)</code> | ||
+ | |||
+ | <source lang="java" highlight="11,16,17"> | ||
+ | private void setCellFormat(String format) { | ||
+ | Book book = spreadsheet.getBook(); | ||
+ | short dstFormat = book.createDataFormat().getFormat(format); | ||
+ | |||
+ | Rect rect = getSelection(); | ||
+ | Worksheet sheet = spreadsheet.getSelectedSheet(); | ||
+ | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | ||
+ | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | ||
+ | Cell cell = Utils.getOrCreateCell(sheet, row, col); | ||
+ | CellStyle srcCellStyle = cell.getCellStyle(); | ||
+ | short srcDataFormat = srcCellStyle.getDataFormat(); | ||
+ | |||
+ | if (srcDataFormat != dstFormat) { | ||
+ | CellStyle newStyle = book.createCellStyle(); | ||
+ | newStyle.cloneStyleFrom(srcCellStyle); | ||
+ | newStyle.setDataFormat(dstFormat); | ||
+ | Ranges.range(sheet, row, col).setStyle(newStyle); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ===Composer=== | ||
+ | ====Current Selection==== | ||
+ | <source lang="java" highlight="3"> | ||
+ | Rect selection; | ||
+ | public void onCellSelection$spreadsheet(CellSelectionEvent event) { | ||
+ | selection = spreadsheet.getSelection(); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====Select Font Family==== | ||
+ | <source lang="java" highlight="4"> | ||
+ | Combobox fontFamily; | ||
+ | public void onSelect$fontFamily() { | ||
+ | String fontName = fontFamily.getText(); | ||
+ | setFontFamily(fontName); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====Select Font Size==== | ||
+ | <source lang="java" highlight="4"> | ||
+ | Combobox fontSize | ||
+ | public void onSelect$fontSize() { | ||
+ | short fontHeight = getFontHeight(Integer.parseInt(fontSize.getText())); | ||
+ | setFontSize(fontHeight); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====Select Font Color==== | ||
+ | |||
+ | <source lang="java" highlight="4"> | ||
+ | Colorbox fontColor; | ||
+ | public void onChange$fontColor() { | ||
+ | String color = fontColor.getColor(); | ||
+ | setFontColor(color); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====Set Font Bold==== | ||
+ | <source lang="java" highlight="5"> | ||
+ | boolean isBold; | ||
+ | Toolbarbutton boldBtn; | ||
+ | public void onClick$boldBtn() { | ||
+ | isBold = !isBold; | ||
+ | setFontBold(isBold); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====Set Font Italic==== | ||
+ | <source lang="java" highlight="5"> | ||
+ | boolean isItalic; | ||
+ | Toolbarbutton italicBtn; | ||
+ | public void onClick$italicBtn() { | ||
+ | isItalic = !isItalic; | ||
+ | setItalic(isItalic); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====Set Font Underline==== | ||
+ | <source lang="java" highlight="5"> | ||
+ | boolean isUnderline; | ||
+ | Toolbarbutton underlineBtn; | ||
+ | public void onClick$underlineBtn() { | ||
+ | isUnderline = !isUnderline; | ||
+ | setUnderline(isUnderline); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====Set Font Strikethrough==== | ||
+ | <source lang="java" highlight="5"> | ||
+ | boolean isStrikethrough; | ||
+ | Toolbarbutton strikethroughBtn; | ||
+ | public void onClick$strikethroughBtn() { | ||
+ | isStrikethrough = !isStrikethrough; | ||
+ | setStrikethrough(isStrikethrough); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====Select Cell Color==== | ||
+ | <source lang="java" highlight="4, 21,22, 24"> | ||
+ | Colorbox cellColor; | ||
+ | public void onChange$cellColor() { | ||
+ | String color = cellColor.getColor(); | ||
+ | setCellColor(color); | ||
+ | } | ||
+ | |||
+ | public void setCellColor(String color) { | ||
+ | Rect rect = getSelection(); | ||
+ | Worksheet sheet = spreadsheet.getSelectedSheet(); | ||
+ | Book book = spreadsheet.getBook(); | ||
+ | final Color newColor = BookHelper.HTMLToColor(book, color); | ||
+ | |||
+ | for (int row = rect.getTop(); row <= rect.getBottom(); row++) { | ||
+ | for (int col = rect.getLeft(); col <= rect.getRight(); col++) { | ||
+ | Cell cell = Utils.getOrCreateCell(sheet, row, col); | ||
+ | CellStyle cellStyle = cell.getCellStyle(); | ||
+ | final Color srcColor = cellStyle.getFillForegroundColorColor(); | ||
+ | |||
+ | if (!Objects.equals(newColor, srcColor)) { | ||
+ | CellStyle newStyle = cloneStyle(cellStyle, book); | ||
+ | newStyle.cloneStyleFrom(cellStyle); | ||
+ | BookHelper.setFillForegroundColor(newStyle, newColor); | ||
+ | |||
+ | Ranges.range(sheet, row, col).setStyle(newStyle); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | }</source> | ||
+ | |||
+ | ====Set Cell Alignment==== | ||
+ | <source lang="java" highlight="24,26"> | ||
+ | public void onAlignClick(ForwardEvent event) { | ||
+ | String alignStr = (String) event.getData(); | ||
+ | |||
+ | short align = CellStyle.ALIGN_GENERAL; | ||
+ | boolean isVer = false; | ||
+ | if (alignStr.equals("left")) { | ||
+ | align = CellStyle.ALIGN_LEFT; | ||
+ | } else if (alignStr.equals("center")) { | ||
+ | align = CellStyle.ALIGN_CENTER; | ||
+ | } else if (alignStr.equals("right")) { | ||
+ | align = CellStyle.ALIGN_RIGHT; | ||
+ | } else if (alignStr.equals("top")) { | ||
+ | align = CellStyle.VERTICAL_TOP; | ||
+ | isVer = true; | ||
+ | } else if (alignStr.equals("middle")) { | ||
+ | align = CellStyle.VERTICAL_CENTER; | ||
+ | isVer = true; | ||
+ | } else if (alignStr.equals("bottom")) { | ||
+ | align = CellStyle.VERTICAL_BOTTOM; | ||
+ | isVer = true; | ||
+ | } | ||
+ | |||
+ | if (!isVer) | ||
+ | setAlignment(align); | ||
+ | else | ||
+ | setVerticalAlignment(align); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====Select Data Format==== | ||
+ | <source lang="java" highlight="3"> | ||
+ | public void onSelect$dateFormat(SelectEvent event) { | ||
+ | String format = (String) dateFormat.getSelectedItem().getValue(); | ||
+ | setCellFormat(format); | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | |||
+ | View complete source of ZUML [https://code.google.com/p/zkbooks/source/browse/trunk/zssessentials/examples/WebContent/config/cellStyle.zul cellStyle.zul] | ||
+ | |||
+ | View complete source of composer [https://code.google.com/p/zkbooks/source/browse/trunk/zssessentials/examples/src/org/zkoss/zssessentials/config/CellStyleComposer.java CellStyleComposer.java] | ||
+ | |||
+ | =Version History= | ||
+ | {{LastUpdated}} | ||
+ | {| border='1px' | width="100%" | ||
+ | ! Version !! Date !! Content | ||
+ | |- | ||
+ | | 2.1.0 | ||
+ | | May, 2011 | ||
+ | | Vertical Alignment | ||
+ | |- | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | |} | ||
{{ZKSpreadsheetEssentialsPageFooter}} | {{ZKSpreadsheetEssentialsPageFooter}} |
Latest revision as of 12:54, 19 January 2022
This article is out of date, please refer to http://books.zkoss.org/wiki/ZK_Spreadsheet_Essentials for more up to date information.
Purpose
ZK Spreadsheet supports various cell style and font style.
Style Supported | Notes |
---|---|
Font / Font Color / Fill Color | Cause of browser limitation, font also depends on installed font on client side |
Border / Border Color | Cause of browser limitation, only solid/dashed/dotted border are supported now. |
Alignment | Horizontal, Vertical Alignment |
Text Wrap & Overflow | |
Merged Cell | Horizontal/Vertical Merged Cell |
Data Formats | Format cell |
Clone Cell Style
To keep original cell style and only modify part of style, we can use the CellStyle.cloneStyleFrom(CellStyle) to clone a cell style.
CellStyle cloneStyle(CellStyle srcStyle, Book book) {
CellStyle newStyle = book.createCellStyle();
newStyle.cloneStyleFrom(srcStyle);
return newStyle;
}
Cell Style
Color
We get color from CellStyle.getFillForegroundColorColor().
After we clone cell style, we can modify color by CellStyle.setFillForegroundColor(Short), and use Range.setStyle(CellStyle) to set new style
public void setCellColor(String color) {
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
final Color newColor = BookHelper.HTMLToColor(book, color);
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
CellStyle cellStyle = cell.getCellStyle();
final Color srcColor = cellStyle.getFillForegroundColorColor();
if (!Objects.equals(newColor, srcColor)) {
CellStyle newStyle = cloneStyle(cellStyle, book);
newStyle.cloneStyleFrom(cellStyle);
BookHelper.setFillForegroundColor(newStyle, newColor);//use CellStyle.setFillForegroundColor
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Alignment
Horizontal alignment
We can get the cell's horizontal alignment information by CellStyle.getAlignment(), and use CellStyle.setAlignment(Short) to set horizontal alignment.
public void setAlignment(short alignment) {
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
short srcAlign = cell.getCellStyle().getAlignment();
if (srcAlign != alignment) {
CellStyle newStyle = cloneStyle(cell.getCellStyle(), book);
newStyle.setAlignment(alignment);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
VerticalAlignment alignment
We can get the cell's vertical alignment information by CellStyle.getVerticalAlignment(), and use CellStyle.setVerticalAlignment(Short) to set vertical alignment.
public void setVerticalAlignment(short alignment) {
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
short srcAlign = cell.getCellStyle().getVerticalAlignment();
if (srcAlign != alignment) {
CellStyle newStyle = cloneStyle(cell.getCellStyle(), book);
newStyle.setVerticalAlignment(alignment);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Border
We can set the border by Range.setBorders(Short, BorderStyle, String)
void setBorder(String border) {
//Border color
String color = "#000000";
//Border style
BorderStyle style = "none".equals(border) ? BorderStyle.NONE : BorderStyle.MEDIUM;
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
int lCol = rect.getLeft();
int rCol = rect.getRight();
int tRow = rect.getTop();
int bRow = rect.getBottom();
if ("bottom".equals(border)) {
Ranges.range(sheet, tRow, lCol, bRow, rCol).
setBorders(BookHelper.BORDER_EDGE_BOTTOM, style, color);
} else if ("top".equals(border)) {
Ranges.range(sheet, tRow, lCol, tRow, rCol).
setBorders(BookHelper.BORDER_EDGE_TOP, style, color);
} else if ("left".equals(border)) {
Ranges.range(sheet, tRow, lCol, bRow, lCol).
setBorders(BookHelper.BORDER_EDGE_LEFT, style, color);
} else if ("right".equals(border)) {
Ranges.range(sheet, tRow, rCol, bRow, rCol).
setBorders(BookHelper.BORDER_EDGE_RIGHT, style, color);
} else if ("none".equals(border)) {
Ranges.range(sheet, tRow, lCol, bRow, rCol).
setBorders(BookHelper.BORDER_FULL, style, color);
} else if ("full".equals(border)) {
Ranges.range(sheet, tRow, lCol, bRow, rCol).
setBorders(BookHelper.BORDER_FULL, style, color);
}
}
Font Style
From CellStyle.getFontIndex(), we get font index in the book, then we can get Font from Book.getFontAt() Book.getFontAt(String) We can get or create Font by BookHelper.getOrCreateFont(Book, Sort, Color, Short, String, Boolean, Boolean, Short, Byte)
Font family
void setFontFamily(String fontName) {
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
Font srcFont = book.getFontAt(cell.getCellStyle().getFontIndex());
if (srcFont.getFontName() != fontName) {
Font newFont = BookHelper.getOrCreateFont(book,
srcFont.getBoldweight(), BookHelper.getFontColor(book, srcFont),
Font.getFontHeight(), fontName, srcFont.getItalic(), srcFont.getStrikeout(),
srcFont.getTypeOffset(), srcFont.getUnderline());
CellStyle newStyle = cloneStyle(cell.getCellStyle(), book);
newStyle.setFont(newFont);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Font size
We can get the font height by using Font.getFontHeight() , however the font size is different from the font height. The font height in unit's of 1/20th of a point, so we can transform the font size to the font height by
short getFontHeight(int fontSize) {
return (short) (fontSize * 20);
}
After we get the font height to set, we can use BookHelper.getOrCreateFont(Book, Sort, Color, Short, String, Boolean, Boolean, Short, Byte).
void setFontSize(short fontHeight) {
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
Font srcFont = book.getFontAt(cell.getCellStyle().getFontIndex());
if (srcFont.getFontHeight() != fontHeight) {
Font newFont = BookHelper.getOrCreateFont(book, srcFont.getBoldweight(),
BookHelper.getFontColor(book, srcFont), fontHeight, srcFont.getFontName(),
srcFont.getItalic(), srcFont.getStrikeout(), srcFont.getTypeOffset(), srcFont.getUnderline());
CellStyle newStyle = cloneStyle(cell.getCellStyle(), book);
newStyle.setFont(newFont);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Bold
We can get the font bold weight by employing Font.getBoldweight()
void setFontBold(boolean isBold) {
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
Font srcFont = book.getFontAt(
cell.getCellStyle().getFontIndex());
boolean srcBold = srcFont.getBoldweight() == Font.BOLDWEIGHT_BOLD;
if (srcBold != isBold) {
Font newFont = BookHelper.getOrCreateFont(book,
isBold ? Font.BOLDWEIGHT_BOLD : Font.BOLDWEIGHT_NORMAL,
BookHelper.getFontColor(book, srcFont), srcFont.getFontHeight(),
srcFont.getFontName(), srcFont.getItalic(), srcFont.getStrikeout(),
srcFont.getTypeOffset(), srcFont.getUnderline());
CellStyle newStyle = cloneStyle(cell.getCellStyle(), book);
newStyle.setFont(newFont);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Italic
We can know whether the font uses italic or not by Font.getItalic()
void setItalic(boolean isItalic) {
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
Font srcFont = book.getFontAt(
cell.getCellStyle().getFontIndex());
boolean srcItalic = srcFont.getItalic();
if (srcItalic != isItalic) {
Font newFont = BookHelper.getOrCreateFont(book,
srcFont.getBoldweight(), BookHelper.getFontColor(book, srcFont),
srcFont.getFontHeight(), srcFont.getFontName(), isItalic,
srcFont.getStrikeout(), srcFont.getTypeOffset(), srcFont.getUnderline());
CellStyle newStyle = cloneStyle(cell.getCellStyle(), book);
newStyle.setFont(newFont);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Underline
We can get the font underline information by using Font.getUnderline()
void setUnderline(boolean isUnderline){
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
Font srcFont = book.getFontAt(
cell.getCellStyle().getFontIndex());
boolean srcUnderline = srcFont.getUnderline() == Font.U_SINGLE;
if (srcUnderline != isUnderline) {
Font newFont = BookHelper.getOrCreateFont(book, srcFont.getBoldweight(),
BookHelper.getFontColor(book, srcFont), srcFont.getFontHeight(),
srcFont.getFontName(), srcFont.getItalic(), srcFont.getStrikeout(),
srcFont.getTypeOffset(), isUnderline ? Font.U_SINGLE : Font.U_NONE);
CellStyle newStyle = cloneStyle(cell.getCellStyle(), book);
newStyle.setFont(newFont);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Strikethrough
We can know whether the font uses strikethrough or not by Font.getStrikeout()
void setStrikethrough(boolean isStrikethrough) {
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
Font srcFont = book.getFontAt(
cell.getCellStyle().getFontIndex());
boolean srcStrikethrough = srcFont.getStrikeout();
if (srcStrikethrough != isStrikethrough) {
Font newFont = BookHelper.getOrCreateFont(book, srcFont.getBoldweight(),
BookHelper.getFontColor(book, srcFont), srcFont.getFontHeight(),
srcFont.getFontName(), srcFont.getItalic(), isStrikethrough,
srcFont.getTypeOffset(), srcFont.getUnderline());
CellStyle newStyle = cloneStyle(cell.getCellStyle(), book);
newStyle.setFont(newFont);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Data Format
Get data format using CellStyle.getDataFormat()
and set new data format using CellStyle.setDataFormat(format)
private void setCellFormat(String format) {
Book book = spreadsheet.getBook();
short dstFormat = book.createDataFormat().getFormat(format);
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
CellStyle srcCellStyle = cell.getCellStyle();
short srcDataFormat = srcCellStyle.getDataFormat();
if (srcDataFormat != dstFormat) {
CellStyle newStyle = book.createCellStyle();
newStyle.cloneStyleFrom(srcCellStyle);
newStyle.setDataFormat(dstFormat);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Composer
Current Selection
Rect selection;
public void onCellSelection$spreadsheet(CellSelectionEvent event) {
selection = spreadsheet.getSelection();
}
Select Font Family
Combobox fontFamily;
public void onSelect$fontFamily() {
String fontName = fontFamily.getText();
setFontFamily(fontName);
}
Select Font Size
Combobox fontSize
public void onSelect$fontSize() {
short fontHeight = getFontHeight(Integer.parseInt(fontSize.getText()));
setFontSize(fontHeight);
}
Select Font Color
Colorbox fontColor;
public void onChange$fontColor() {
String color = fontColor.getColor();
setFontColor(color);
}
Set Font Bold
boolean isBold;
Toolbarbutton boldBtn;
public void onClick$boldBtn() {
isBold = !isBold;
setFontBold(isBold);
}
Set Font Italic
boolean isItalic;
Toolbarbutton italicBtn;
public void onClick$italicBtn() {
isItalic = !isItalic;
setItalic(isItalic);
}
Set Font Underline
boolean isUnderline;
Toolbarbutton underlineBtn;
public void onClick$underlineBtn() {
isUnderline = !isUnderline;
setUnderline(isUnderline);
}
Set Font Strikethrough
boolean isStrikethrough;
Toolbarbutton strikethroughBtn;
public void onClick$strikethroughBtn() {
isStrikethrough = !isStrikethrough;
setStrikethrough(isStrikethrough);
}
Select Cell Color
Colorbox cellColor;
public void onChange$cellColor() {
String color = cellColor.getColor();
setCellColor(color);
}
public void setCellColor(String color) {
Rect rect = getSelection();
Worksheet sheet = spreadsheet.getSelectedSheet();
Book book = spreadsheet.getBook();
final Color newColor = BookHelper.HTMLToColor(book, color);
for (int row = rect.getTop(); row <= rect.getBottom(); row++) {
for (int col = rect.getLeft(); col <= rect.getRight(); col++) {
Cell cell = Utils.getOrCreateCell(sheet, row, col);
CellStyle cellStyle = cell.getCellStyle();
final Color srcColor = cellStyle.getFillForegroundColorColor();
if (!Objects.equals(newColor, srcColor)) {
CellStyle newStyle = cloneStyle(cellStyle, book);
newStyle.cloneStyleFrom(cellStyle);
BookHelper.setFillForegroundColor(newStyle, newColor);
Ranges.range(sheet, row, col).setStyle(newStyle);
}
}
}
}
Set Cell Alignment
public void onAlignClick(ForwardEvent event) {
String alignStr = (String) event.getData();
short align = CellStyle.ALIGN_GENERAL;
boolean isVer = false;
if (alignStr.equals("left")) {
align = CellStyle.ALIGN_LEFT;
} else if (alignStr.equals("center")) {
align = CellStyle.ALIGN_CENTER;
} else if (alignStr.equals("right")) {
align = CellStyle.ALIGN_RIGHT;
} else if (alignStr.equals("top")) {
align = CellStyle.VERTICAL_TOP;
isVer = true;
} else if (alignStr.equals("middle")) {
align = CellStyle.VERTICAL_CENTER;
isVer = true;
} else if (alignStr.equals("bottom")) {
align = CellStyle.VERTICAL_BOTTOM;
isVer = true;
}
if (!isVer)
setAlignment(align);
else
setVerticalAlignment(align);
}
Select Data Format
public void onSelect$dateFormat(SelectEvent event) {
String format = (String) dateFormat.getSelectedItem().getValue();
setCellFormat(format);
}
View complete source of ZUML cellStyle.zul
View complete source of composer CellStyleComposer.java
Version History
Version | Date | Content |
---|---|---|
2.1.0 | May, 2011 | Vertical Alignment |
All source code listed in this book is at Github.