org.apache.poi.xddf.usermodel.chart.XDDFDateAxis Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of poi-ooxml Show documentation
Show all versions of poi-ooxml Show documentation
Apache POI - Java API To Access Microsoft Format Files
/* ====================================================================
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.xddf.usermodel.chart;
import org.apache.poi.util.Beta;
import org.apache.poi.xddf.usermodel.XDDFShapeProperties;
import org.apache.poi.xddf.usermodel.text.XDDFRunProperties;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTAxPos;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTBoolean;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTChartLines;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTCrosses;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTDateAx;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTNumFmt;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTPlotArea;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTScaling;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTTickLblPos;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTUnsignedInt;
import org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextBody;
/**
* Date axis type. Currently only implements the same values as
* {@link XDDFCategoryAxis}, since the two are nearly identical.
*/
@Beta
public class XDDFDateAxis extends XDDFChartAxis {
private CTDateAx ctDateAx;
public XDDFDateAxis(CTPlotArea plotArea, AxisPosition position) {
initializeAxis(plotArea, position);
}
public XDDFDateAxis(CTDateAx ctDateAx) {
this.ctDateAx = ctDateAx;
}
@Override
public XDDFShapeProperties getOrAddMajorGridProperties() {
CTChartLines majorGridlines;
if (ctDateAx.isSetMajorGridlines()) {
majorGridlines = ctDateAx.getMajorGridlines();
} else {
majorGridlines = ctDateAx.addNewMajorGridlines();
}
return new XDDFShapeProperties(getOrAddLinesProperties(majorGridlines));
}
@Override
public XDDFShapeProperties getOrAddMinorGridProperties() {
CTChartLines minorGridlines;
if (ctDateAx.isSetMinorGridlines()) {
minorGridlines = ctDateAx.getMinorGridlines();
} else {
minorGridlines = ctDateAx.addNewMinorGridlines();
}
return new XDDFShapeProperties(getOrAddLinesProperties(minorGridlines));
}
@Override
public XDDFShapeProperties getOrAddShapeProperties() {
CTShapeProperties properties;
if (ctDateAx.isSetSpPr()) {
properties = ctDateAx.getSpPr();
} else {
properties = ctDateAx.addNewSpPr();
}
return new XDDFShapeProperties(properties);
}
/**
* @since POI 4.0.2
*/
@Override
public XDDFRunProperties getOrAddTextProperties() {
CTTextBody text;
if (ctDateAx.isSetTxPr()) {
text = ctDateAx.getTxPr();
} else {
text = ctDateAx.addNewTxPr();
}
return new XDDFRunProperties(getOrAddTextProperties(text));
}
/**
* @since 4.0.1
*/
@Override
public void setTitle(String text) {
if (!ctDateAx.isSetTitle()) {
ctDateAx.addNewTitle();
}
XDDFTitle title = new XDDFTitle(null, ctDateAx.getTitle());
title.setOverlay(false);
title.setText(text);
}
@Override
public boolean isSetMinorUnit() {
return ctDateAx.isSetMinorUnit();
}
@Override
public void setMinorUnit(double minor) {
if (Double.isNaN(minor)) {
if (ctDateAx.isSetMinorUnit()) {
ctDateAx.unsetMinorUnit();
}
} else {
if (ctDateAx.isSetMinorUnit()) {
ctDateAx.getMinorUnit().setVal(minor);
} else {
ctDateAx.addNewMinorUnit().setVal(minor);
}
}
}
@Override
public double getMinorUnit() {
if (ctDateAx.isSetMinorUnit()) {
return ctDateAx.getMinorUnit().getVal();
} else {
return Double.NaN;
}
}
@Override
public boolean isSetMajorUnit() {
return ctDateAx.isSetMajorUnit();
}
@Override
public void setMajorUnit(double major) {
if (Double.isNaN(major)) {
if (ctDateAx.isSetMajorUnit()) {
ctDateAx.unsetMajorUnit();
}
} else {
if (ctDateAx.isSetMajorUnit()) {
ctDateAx.getMajorUnit().setVal(major);
} else {
ctDateAx.addNewMajorUnit().setVal(major);
}
}
}
@Override
public double getMajorUnit() {
if (ctDateAx.isSetMajorUnit()) {
return ctDateAx.getMajorUnit().getVal();
} else {
return Double.NaN;
}
}
@Override
public void crossAxis(XDDFChartAxis axis) {
ctDateAx.getCrossAx().setVal(axis.getId());
}
@Override
protected CTUnsignedInt getCTAxId() {
return ctDateAx.getAxId();
}
@Override
protected CTAxPos getCTAxPos() {
return ctDateAx.getAxPos();
}
@Override
public boolean hasNumberFormat() {
return ctDateAx.isSetNumFmt();
}
@Override
protected CTNumFmt getCTNumFmt() {
if (ctDateAx.isSetNumFmt()) {
return ctDateAx.getNumFmt();
}
return ctDateAx.addNewNumFmt();
}
@Override
protected CTScaling getCTScaling() {
return ctDateAx.getScaling();
}
@Override
protected CTCrosses getCTCrosses() {
CTCrosses crosses = ctDateAx.getCrosses();
if (crosses == null) {
return ctDateAx.addNewCrosses();
} else {
return crosses;
}
}
@Override
protected CTBoolean getDelete() {
return ctDateAx.getDelete();
}
@Override
protected CTTickMark getMajorCTTickMark() {
return ctDateAx.getMajorTickMark();
}
@Override
protected CTTickMark getMinorCTTickMark() {
return ctDateAx.getMinorTickMark();
}
@Override
protected CTTickLblPos getCTTickLblPos() {
return ctDateAx.getTickLblPos();
}
private void initializeAxis(CTPlotArea plotArea, AxisPosition position) {
final long id = getNextAxId(plotArea);
ctDateAx = plotArea.addNewDateAx();
ctDateAx.addNewAxId().setVal(id);
ctDateAx.addNewAuto().setVal(false);
ctDateAx.addNewAxPos();
ctDateAx.addNewScaling();
ctDateAx.addNewCrosses();
ctDateAx.addNewCrossAx();
ctDateAx.addNewTickLblPos();
ctDateAx.addNewDelete();
ctDateAx.addNewMajorTickMark();
ctDateAx.addNewMinorTickMark();
ctDateAx.addNewNumFmt().setSourceLinked(true);
ctDateAx.getNumFmt().setFormatCode("");
setPosition(position);
setOrientation(AxisOrientation.MIN_MAX);
setCrosses(AxisCrosses.AUTO_ZERO);
setVisible(true);
setMajorTickMark(AxisTickMark.CROSS);
setMinorTickMark(AxisTickMark.NONE);
setTickLabelPosition(AxisTickLabelPosition.NEXT_TO);
}
}