123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204 |
- /*
- * 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.
- */
-
- /* $Id$ */
-
- package org.apache.fop.fo.properties;
-
- import org.apache.fop.datatypes.CompoundDatatype;
- import org.apache.fop.fo.FObj;
- import org.apache.fop.fo.PropertyList;
- import org.apache.fop.fo.expr.PropertyException;
-
- /**
- * Class for properties that wrap Keep values
- */
- public final class KeepProperty extends Property implements CompoundDatatype {
-
- /** class holding all canonical KeepProperty instances*/
- private static final PropertyCache<KeepProperty> CACHE
- = new PropertyCache<KeepProperty>();
-
- private boolean isCachedValue;
- private Property withinLine;
- private Property withinColumn;
- private Property withinPage;
-
- /**
- * Inner class for creating instances of KeepProperty
- */
- public static class Maker extends CompoundPropertyMaker {
-
- /**
- * @param propId the id of the property for which a Maker should be created
- */
- public Maker(int propId) {
- super(propId);
- }
-
- /**
- * Create a new empty instance of KeepProperty.
- * @return the new instance.
- */
- public Property makeNewProperty() {
- return new KeepProperty();
- }
-
- /**
- * {@inheritDoc}
- */
- public Property convertProperty(Property p, PropertyList propertyList, FObj fo)
- throws PropertyException {
- if (p instanceof KeepProperty) {
- return p;
- }
- return super.convertProperty(p, propertyList, fo);
- }
- }
-
- /**
- * {@inheritDoc}
- */
- public void setComponent(int cmpId, Property cmpnValue,
- boolean bIsDefault) {
- if (isCachedValue) {
- log.warn("KeepProperty.setComponent() called on cached value. Ignoring...");
- return;
- }
- if (cmpId == CP_WITHIN_LINE) {
- setWithinLine(cmpnValue, bIsDefault);
- } else if (cmpId == CP_WITHIN_COLUMN) {
- setWithinColumn(cmpnValue, bIsDefault);
- } else if (cmpId == CP_WITHIN_PAGE) {
- setWithinPage(cmpnValue, bIsDefault);
- }
- }
-
- /**
- * {@inheritDoc}
- */
- public Property getComponent(int cmpId) {
- if (cmpId == CP_WITHIN_LINE) {
- return getWithinLine();
- } else if (cmpId == CP_WITHIN_COLUMN) {
- return getWithinColumn();
- } else if (cmpId == CP_WITHIN_PAGE) {
- return getWithinPage();
- } else {
- return null;
- }
- }
-
- /**
- * @param withinLine withinLine property to set
- * @param bIsDefault not used (??)
- */
- public void setWithinLine(Property withinLine, boolean bIsDefault) {
- this.withinLine = withinLine;
- }
-
- /**
- * @param withinColumn withinColumn property to set
- * @param bIsDefault not used (??)
- */
- protected void setWithinColumn(Property withinColumn,
- boolean bIsDefault) {
- this.withinColumn = withinColumn;
- }
-
- /**
- * @param withinPage withinPage property to set
- * @param bIsDefault not used (??)
- */
- public void setWithinPage(Property withinPage, boolean bIsDefault) {
- this.withinPage = withinPage;
- }
-
- /**
- * @return the withinLine property
- */
- public Property getWithinLine() {
- return this.withinLine;
- }
-
- /**
- * @return the withinColumn property
- */
- public Property getWithinColumn() {
- return this.withinColumn;
- }
-
- /**
- * @return the withinPage property
- */
- public Property getWithinPage() {
- return this.withinPage;
- }
-
- /**
- * Not sure what to do here. There isn't really a meaningful single value.
- * @return String representation
- */
- public String toString() {
- return "Keep["
- + "withinLine:" + getWithinLine().getObject()
- + ", withinColumn:" + getWithinColumn().getObject()
- + ", withinPage:" + getWithinPage().getObject() + "]";
- }
-
- /**
- * @return the canonical KeepProperty instance corresponding to
- * this property
- */
- public KeepProperty getKeep() {
- KeepProperty keep = CACHE.fetch(this);
- /* make sure setComponent() can never alter cached values */
- keep.isCachedValue = true;
- return keep;
- }
-
- /**
- * @return this.keep cast as Object
- */
- public Object getObject() {
- return this;
- }
-
- /** {@inheritDoc} */
- public boolean equals(Object o) {
- if (this == o) {
- return true;
- }
-
- if (o instanceof KeepProperty) {
- KeepProperty keep = (KeepProperty) o;
- return (keep.withinColumn == this.withinColumn)
- && (keep.withinLine == this.withinLine)
- && (keep.withinPage == this.withinPage);
- }
- return false;
- }
-
- /** {@inheritDoc} */
- public int hashCode() {
- int hash = 17;
- hash = 37 * hash + (withinColumn == null ? 0 : withinColumn.hashCode());
- hash = 37 * hash + (withinLine == null ? 0 : withinLine.hashCode());
- hash = 37 * hash + (withinPage == null ? 0 : withinPage.hashCode());
- return hash;
- }
- }
|