123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190 |
- /*
- * EnumType.java
- * $Id$
- *
- * Created: Tue Nov 20 22:18:11 2001
- *
- *
- * Copyright 1999-2003 The Apache Software Foundation.
- *
- * Licensed 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.fop.datatypes;
-
- import org.apache.fop.fo.PropNames;
- import org.apache.fop.fo.expr.PropertyException;
- import org.apache.fop.fo.properties.Property;
-
- /**
- * Base class for representing enumerated values. The value is maintained as
- * an <tt>int</tt> constant value.
- * @author <a href="mailto:pbwest@powerup.com.au">Peter B. West</a>
- * @version $Revision$ $Name$
- */
-
- public class EnumType extends AbstractPropertyValue {
-
- private static final String tag = "$Name$";
- private static final String revision = "$Revision$";
-
- /**
- * An integer enumeration value.
- */
- protected int enumValue;
-
- /**
- * @param property the <tt>int</tt> index of the property on which
- * this value is being defined.
- * @param enumText the <tt>String</tt> containing the enumeration text.
- * An <i>NCName</i>.
- * @exception PropertyException
- */
- public EnumType(int property, String enumText)
- throws PropertyException
- {
- this(property, enumText, PropertyValue.ENUM);
- }
-
- /**
- * @param property the <tt>int</tt> index of the property on which
- * this value is being defined.
- * @param enum the <tt>int</tt> enumeration constant.
- * @exception PropertyException
- */
- public EnumType(int property, int enum)
- throws PropertyException
- {
- this(property, enum, PropertyValue.ENUM);
- }
-
- /**
- * @param propertyName the <tt>String</tt> name of the property on which
- * this value is being defined.
- * @param enumText the <tt>String</tt> containing the enumeration text.
- * An <i>NCName</i>.
- * @exception PropertyException
- */
- public EnumType(String propertyName, String enumText)
- throws PropertyException
- {
- this(PropNames.getPropertyIndex(propertyName),
- enumText, PropertyValue.ENUM);
- }
-
- /**
- * @param propertyName the <tt>String</tt> name of the property on which
- * this value is being defined.
- * @param enum the <tt>int</tt> enumeration constant.
- * @exception PropertyException
- */
- public EnumType(String propertyName, int enum)
- throws PropertyException
- {
- this(PropNames.getPropertyIndex(propertyName),
- enum, PropertyValue.ENUM);
- }
-
- /**
- * @param property the <tt>int</tt> index of the property on which
- * this value is being defined.
- * @param enumText the <tt>String</tt> containing the enumeration text.
- * An <i>NCName</i>.
- * @param type of this value
- * @exception PropertyException
- */
- public EnumType(int property, String enumText, int type)
- throws PropertyException
- {
- super(property, type);
- // Get the enum integer or mapped enum integer
- enumValue = propertyConsts.getEnumIndex(property, enumText);
- }
-
- /**
- * @param property the <tt>int</tt> index of the property on which
- * this value is being defined.
- * @param enum the <tt>int</tt> enumeration constant.
- * @param type of this value
- * @exception PropertyException
- */
- public EnumType(int property, int enum, int type)
- throws PropertyException
- {
- super(property, type);
- enumValue = enum;
- // Validate the text; getEnumText will throw a PropertyException
- // if the enum integer is invalid
- String enumText = propertyConsts.getEnumText(property, enum);
- }
-
- /**
- * @param propertyName the <tt>String</tt> name of the property on which
- * this value is being defined.
- * @param enumText the <tt>String</tt> containing the enumeration text.
- * An <i>NCName</i>.
- * @param type of this value
- * @exception PropertyException
- */
- public EnumType(String propertyName, String enumText, int type)
- throws PropertyException
- {
- this(PropNames.getPropertyIndex(propertyName), enumText, type);
- }
-
- /**
- * @param propertyName the <tt>String</tt> name of the property on which
- * this value is being defined.
- * @param enum the <tt>int</tt> enumeration constant.
- * @param type of this value
- * @exception PropertyException
- */
- public EnumType(String propertyName, int enum, int type)
- throws PropertyException
- {
- this(PropNames.getPropertyIndex(propertyName), enum, type);
- }
-
- /**
- * @return the <tt>int</tt> ENUM value.
- */
- public int getEnumValue() {
- return enumValue;
- }
-
- /**
- * @return the <tt>String</tt> enumeration token.
- */
- public String getEnumToken() throws PropertyException {
- return propertyConsts.getEnumText(property, enumValue);
- }
-
- /**
- * validate the <i>EnumType</i> against the associated property.
- */
- public void validate() throws PropertyException {
- super.validate(Property.ENUM);
- }
-
- public String toString() {
- String enumText;
- try {
- enumText = propertyConsts.getEnumText(property, enumValue);
- } catch (PropertyException e) {
- throw new RuntimeException(e.getMessage());
- }
- return enumText + " " + enumValue + "\n" + super.toString();
- }
-
- }
|