123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269 |
- /*
- * 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.flow;
-
- import java.util.Stack;
-
- import org.apache.fop.accessibility.StructureTreeElement;
- import org.apache.fop.apps.FOPException;
- import org.apache.fop.complexscripts.bidi.DelimitedTextRange;
- import org.apache.fop.datatypes.Length;
- import org.apache.fop.fo.FONode;
- import org.apache.fop.fo.FObj;
- import org.apache.fop.fo.GraphicsProperties;
- import org.apache.fop.fo.PropertyList;
- import org.apache.fop.fo.properties.CommonAccessibility;
- import org.apache.fop.fo.properties.CommonAccessibilityHolder;
- import org.apache.fop.fo.properties.CommonBorderPaddingBackground;
- import org.apache.fop.fo.properties.KeepProperty;
- import org.apache.fop.fo.properties.LengthRangeProperty;
- import org.apache.fop.fo.properties.SpaceProperty;
- import org.apache.fop.fo.properties.StructureTreeElementHolder;
- import org.apache.fop.util.CharUtilities;
-
- /**
- * Common base class for the <a href="http://www.w3.org/TR/xsl/#fo_instream-foreign-object">
- * <code>fo:instream-foreign-object</code></a>
- * and <a href="http://www.w3.org/TR/xsl/#fo_external-graphic">
- * <code>fo:external-graphic</code></a> flow formatting objects.
- */
- public abstract class AbstractGraphics extends FObj
- implements GraphicsProperties, StructureTreeElementHolder, CommonAccessibilityHolder {
-
- // The value of properties relevant for fo:instream-foreign-object
- // and external-graphics.
- private CommonAccessibility commonAccessibility;
- private CommonBorderPaddingBackground commonBorderPaddingBackground;
- private Length alignmentAdjust;
- private int alignmentBaseline;
- private Length baselineShift;
- private LengthRangeProperty blockProgressionDimension;
- // private ToBeImplementedProperty clip;
- private Length contentHeight;
- private Length contentWidth;
- private int displayAlign;
- private int dominantBaseline;
- private Length height;
- private String id;
- private LengthRangeProperty inlineProgressionDimension;
- private KeepProperty keepWithNext;
- private KeepProperty keepWithPrevious;
- private SpaceProperty lineHeight;
- private int overflow;
- private int scaling;
- private int textAlign;
- private Length width;
- private String altText;
- private StructureTreeElement structureTreeElement;
- // Unused but valid items, commented out for performance:
- // private CommonAccessibility commonAccessibility;
- // private CommonAural commonAural;
- // private CommonMarginInline commonMarginInline;
- // private CommonRelativePosition commonRelativePosition;
- // private String contentType;
- // private int scalingMethod;
- // End of property values
-
- /**
- * constructs an instream-foreign-object object (called by Maker).
- *
- * @param parent the parent formatting object
- */
- public AbstractGraphics(FONode parent) {
- super(parent);
- }
-
- /** {@inheritDoc} */
- public void bind(PropertyList pList) throws FOPException {
- commonAccessibility = CommonAccessibility.getInstance(pList);
- commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
- alignmentAdjust = pList.get(PR_ALIGNMENT_ADJUST).getLength();
- alignmentBaseline = pList.get(PR_ALIGNMENT_BASELINE).getEnum();
- baselineShift = pList.get(PR_BASELINE_SHIFT).getLength();
- blockProgressionDimension = pList.get(PR_BLOCK_PROGRESSION_DIMENSION).getLengthRange();
- // clip = pList.get(PR_CLIP);
- contentHeight = pList.get(PR_CONTENT_HEIGHT).getLength();
- contentWidth = pList.get(PR_CONTENT_WIDTH).getLength();
- displayAlign = pList.get(PR_DISPLAY_ALIGN).getEnum();
- dominantBaseline = pList.get(PR_DOMINANT_BASELINE).getEnum();
- height = pList.get(PR_HEIGHT).getLength();
- id = pList.get(PR_ID).getString();
- inlineProgressionDimension = pList.get(PR_INLINE_PROGRESSION_DIMENSION).getLengthRange();
- keepWithNext = pList.get(PR_KEEP_WITH_NEXT).getKeep();
- keepWithPrevious = pList.get(PR_KEEP_WITH_PREVIOUS).getKeep();
- lineHeight = pList.get(PR_LINE_HEIGHT).getSpace();
- overflow = pList.get(PR_OVERFLOW).getEnum();
- scaling = pList.get(PR_SCALING).getEnum();
- textAlign = pList.get(PR_TEXT_ALIGN).getEnum();
- width = pList.get(PR_WIDTH).getLength();
- if (getUserAgent().isAccessibilityEnabled()) {
- altText = pList.get(PR_X_ALT_TEXT).getString();
- if (altText.equals("")) {
- getFOValidationEventProducer().altTextMissing(this, getLocalName(), getLocator());
- }
- }
- }
-
- /** {@inheritDoc} */
- public CommonAccessibility getCommonAccessibility() {
- return commonAccessibility;
- }
-
- /**
- * @return the "id" property.
- */
- public String getId() {
- return id;
- }
-
- /** @return the {@link CommonBorderPaddingBackground} */
- public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
- return commonBorderPaddingBackground;
- }
-
- /** @return the "line-height" property */
- public SpaceProperty getLineHeight() {
- return lineHeight;
- }
-
- /** @return the "inline-progression-dimension" property */
- public LengthRangeProperty getInlineProgressionDimension() {
- return inlineProgressionDimension;
- }
-
- /** @return the "block-progression-dimension" property */
- public LengthRangeProperty getBlockProgressionDimension() {
- return blockProgressionDimension;
- }
-
- /** @return the "height" property */
- public Length getHeight() {
- return height;
- }
-
- /** @return the "width" property */
- public Length getWidth() {
- return width;
- }
-
- /** @return the "content-height" property */
- public Length getContentHeight() {
- return contentHeight;
- }
-
- /** @return the "content-width" property */
- public Length getContentWidth() {
- return contentWidth;
- }
-
- /** @return the "scaling" property */
- public int getScaling() {
- return scaling;
- }
-
- /** @return the "overflow" property */
- public int getOverflow() {
- return overflow;
- }
-
- /** {@inheritDoc} */
- public int getDisplayAlign() {
- return displayAlign;
- }
-
- /** {@inheritDoc} */
- public int getTextAlign() {
- return textAlign;
- }
-
- /** @return the "alignment-adjust" property */
- public Length getAlignmentAdjust() {
- if (alignmentAdjust.getEnum() == EN_AUTO) {
- final Length intrinsicAlignmentAdjust = this.getIntrinsicAlignmentAdjust();
- if (intrinsicAlignmentAdjust != null) {
- return intrinsicAlignmentAdjust;
- }
- }
- return alignmentAdjust;
- }
-
- /** @return the "alignment-baseline" property */
- public int getAlignmentBaseline() {
- return alignmentBaseline;
- }
-
- /** @return the "baseline-shift" property */
- public Length getBaselineShift() {
- return baselineShift;
- }
-
- /** @return the "dominant-baseline" property */
- public int getDominantBaseline() {
- return dominantBaseline;
- }
-
- /** @return the "keep-with-next" property */
- public KeepProperty getKeepWithNext() {
- return keepWithNext;
- }
-
- /** @return the "keep-with-previous" property */
- public KeepProperty getKeepWithPrevious() {
- return keepWithPrevious;
- }
-
- @Override
- public void setStructureTreeElement(StructureTreeElement structureTreeElement) {
- this.structureTreeElement = structureTreeElement;
- }
-
- /** {@inheritDoc} */
- public StructureTreeElement getStructureTreeElement() {
- return structureTreeElement;
- }
-
- /** @return the alternative text property. */
- public String getAltText() {
- return altText;
- }
-
- /** @return the graphic's intrinsic width in millipoints */
- public abstract int getIntrinsicWidth();
-
- /** @return the graphic's intrinsic height in millipoints */
- public abstract int getIntrinsicHeight();
-
- /** @return the graphic's intrinsic alignment-adjust */
- public abstract Length getIntrinsicAlignmentAdjust();
-
- @Override
- public boolean isDelimitedTextRangeBoundary ( int boundary ) {
- return false;
- }
-
- @Override
- protected Stack collectDelimitedTextRanges ( Stack ranges, DelimitedTextRange currentRange ) {
- if ( currentRange != null ) {
- currentRange.append ( CharUtilities.OBJECT_REPLACEMENT_CHARACTER, this );
- }
- return ranges;
- }
-
- }
|