1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.xssf.model;
import static org.apache.poi.POIXMLTypeLoader.DEFAULT_XML_OPTIONS;
import java.io.IOException;
import java.io.OutputStream;
import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.xssf.usermodel.XSSFColor;
import org.apache.xmlbeans.XmlException;
import org.openxmlformats.schemas.drawingml.x2006.main.CTColor;
import org.openxmlformats.schemas.drawingml.x2006.main.CTColorScheme;
import org.openxmlformats.schemas.drawingml.x2006.main.ThemeDocument;
/**
* Class that represents theme of XLSX document. The theme includes specific
* colors and fonts.
*/
public class ThemesTable extends POIXMLDocumentPart {
public enum ThemeElement {
LT1(0, "Lt1"),
DK1(1,"Dk1"),
LT2(2,"Lt2"),
DK2(3,"Dk2"),
ACCENT1(4,"Accent1"),
ACCENT2(5,"Accent2"),
ACCENT3(6,"Accent3"),
ACCENT4(7,"Accent4"),
ACCENT5(8,"Accent5"),
ACCENT6(9,"Accent6"),
HLINK(10,"Hlink"),
FOLHLINK(11,"FolHlink"),
UNKNOWN(-1,null);
public static ThemeElement byId(int idx) {
if (idx >= values().length || idx < 0) return UNKNOWN;
return values()[idx];
}
private ThemeElement(int idx, String name) {
this.idx = idx; this.name = name;
}
public final int idx;
public final String name;
}
private ThemeDocument theme;
/**
* Create a new, empty ThemesTable
*/
public ThemesTable() {
super();
theme = ThemeDocument.Factory.newInstance();
theme.addNewTheme().addNewThemeElements();
}
/**
* Construct a ThemesTable.
* @param part A PackagePart.
*
* @since POI 3.14-Beta1
*/
public ThemesTable(PackagePart part) throws IOException {
super(part);
try {
theme = ThemeDocument.Factory.parse(part.getInputStream(), DEFAULT_XML_OPTIONS);
} catch(XmlException e) {
throw new IOException(e.getLocalizedMessage(), e);
}
}
/**
* Construct a ThemesTable from an existing ThemeDocument.
* @param theme A ThemeDocument.
*/
public ThemesTable(ThemeDocument theme) {
this.theme = theme;
}
/**
* Convert a theme "index" (as used by fonts etc) into a color.
* @param idx A theme "index"
* @return The mapped XSSFColor, or null if not mapped.
*/
public XSSFColor getThemeColor(int idx) {
// Theme color references are NOT positional indices into the color scheme,
// i.e. these keys are NOT the same as the order in which theme colors appear
// in theme1.xml. They are keys to a mapped color.
CTColorScheme colorScheme = theme.getTheme().getThemeElements().getClrScheme();
CTColor ctColor;
switch (ThemeElement.byId(idx)) {
case LT1: ctColor = colorScheme.getLt1(); break;
case DK1: ctColor = colorScheme.getDk1(); break;
case LT2: ctColor = colorScheme.getLt2(); break;
case DK2: ctColor = colorScheme.getDk2(); break;
case ACCENT1: ctColor = colorScheme.getAccent1(); break;
case ACCENT2: ctColor = colorScheme.getAccent2(); break;
case ACCENT3: ctColor = colorScheme.getAccent3(); break;
case ACCENT4: ctColor = colorScheme.getAccent4(); break;
case ACCENT5: ctColor = colorScheme.getAccent5(); break;
case ACCENT6: ctColor = colorScheme.getAccent6(); break;
case HLINK: ctColor = colorScheme.getHlink(); break;
case FOLHLINK:ctColor = colorScheme.getFolHlink();break;
default: return null;
}
byte[] rgb = null;
if (ctColor.isSetSrgbClr()) {
// Color is a regular one
rgb = ctColor.getSrgbClr().getVal();
} else if (ctColor.isSetSysClr()) {
// Color is a tint of white or black
rgb = ctColor.getSysClr().getLastClr();
} else {
return null;
}
return new XSSFColor(rgb);
}
/**
* If the colour is based on a theme, then inherit
* information (currently just colours) from it as
* required.
*/
public void inheritFromThemeAsRequired(XSSFColor color) {
if(color == null) {
// Nothing for us to do
return;
}
if(! color.getCTColor().isSetTheme()) {
// No theme set, nothing to do
return;
}
// Get the theme colour
XSSFColor themeColor = getThemeColor(color.getTheme());
// Set the raw colour, not the adjusted one
// Do a raw set, no adjusting at the XSSFColor layer either
color.getCTColor().setRgb(themeColor.getCTColor().getRgb());
// All done
}
/**
* Write this table out as XML.
*
* @param out The stream to write to.
* @throws IOException if an error occurs while writing.
*/
public void writeTo(OutputStream out) throws IOException {
theme.save(out, DEFAULT_XML_OPTIONS);
}
@Override
protected void commit() throws IOException {
PackagePart part = getPackagePart();
OutputStream out = part.getOutputStream();
writeTo(out);
out.close();
}
}
|
