| |
| /* ==================================================================== |
| 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.ddf; |
| |
| import org.apache.poi.util.HexDump; |
| |
| /** |
| * Represents a boolean property. The actual utility of this property is in doubt because many |
| * of the properties marked as boolean seem to actually contain special values. In other words |
| * they're not true booleans. |
| * |
| * @see EscherSimpleProperty |
| * @see EscherProperty |
| */ |
| public class EscherBoolProperty |
| extends EscherSimpleProperty |
| { |
| /** |
| * Create an instance of an escher boolean property. |
| * |
| * @param propertyNumber The property number (or id) |
| * @param value The 32 bit value of this bool property |
| */ |
| public EscherBoolProperty( short propertyNumber, int value ) |
| { |
| super(propertyNumber, value); |
| } |
| |
| /** |
| * Whether this boolean property is true |
| * |
| * @return the boolean property value |
| */ |
| public boolean isTrue() |
| { |
| return getPropertyValue() != 0; |
| } |
| |
| /** |
| * Whether this boolean property is false |
| * |
| * @return true, if this boolean property is false |
| * |
| * @deprecated use !isTrue() instead, planed to be removed in POI 3.17 |
| */ |
| public boolean isFalse() |
| { |
| return !isTrue(); |
| } |
| |
| // public String toString() |
| // { |
| // return "propNum: " + getPropertyNumber() |
| // + ", complex: " + isComplex() |
| // + ", blipId: " + isBlipId() |
| // + ", value: " + (getValue() != 0); |
| // } |
| |
| @Override |
| public String toXml(String tab){ |
| StringBuilder builder = new StringBuilder(); |
| builder.append(tab).append("<").append(getClass().getSimpleName()).append(" id=\"0x").append(HexDump.toHex(getId())) |
| .append("\" name=\"").append(getName()).append("\" simpleValue=\"").append(getPropertyValue()).append("\" blipId=\"") |
| .append(isBlipId()).append("\" value=\"").append(isTrue()).append("\"").append("/>\n"); |
| return builder.toString(); |
| } |
| } |