1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071 |
- /*
- * Copyright 2004 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.
- */
-
- /* $Id$ */
-
- package org.apache.fop.layoutmgr;
-
- /**
- * An instance of this class represents information about a feasible
- * breaking point; it does not represent any piece of content.
- *
- * A KnuthPenalty is a feasible breaking point unless its value is infinity;
- * a KnuthPenalty whose value is -infinity represents a forced break.
- *
- * A KnuthPenalty is suppressed, and its width is ignored, if it is not a
- * chosen breaking point; for example, a KnuthPenalty representing a
- * hyphenation point has a width (the "-" width), which must be ignored if
- * that point is not chosen as a breaking point.
- *
- * Besides the inherited methods and attributes, this class has two more
- * attributes and the methods used to get them: the penalty value, which is
- * a kind of "aesthetic cost" (the higher the value, the more unsightly the
- * breaking point), and a boolean that marks KnuthPenalties which should not
- * be chosen as breaking points for consecutive lines.
- */
- public class KnuthPenalty extends KnuthElement {
- private int penalty;
- private boolean bFlagged;
-
- /**
- * Create a new KnuthPenalty.
- *
- * @param w the width of this penalty
- * @param p the penalty value of this penalty
- * @param f is this penalty flagged?
- * @param pos the Position stored in this penalty
- * @param bAux is this penalty auxiliary?
- */
- public KnuthPenalty(int w, int p, boolean f, Position pos, boolean bAux) {
- super(KNUTH_PENALTY, w, pos, bAux);
- penalty = p;
- bFlagged = f;
- }
-
- /**
- * Return the penalty value of this penalty.
- */
- public int getP() {
- return penalty;
- }
-
- /**
- * Return true is this penalty is a flagged one.
- */
- public boolean isFlagged() {
- return bFlagged;
- }
- }
|