/*
 * 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: Position.java 1052561 2010-12-24 19:28:11Z spepping $ */

package org.apache.fop.layoutmgr;

A position. /** A position. */
public class Position {

    private LayoutManager layoutManager;
    private int index = -1;

    
Construct a position.
Params:
lm – the associated layout manager/**
     * Construct a position.
     * @param lm the associated layout manager
     */
    public Position(LayoutManager lm) {
        layoutManager = lm;
    }

    
Construct a position.
Params:
lm – the associated layout manager
index – the index/**
     * Construct a position.
     * @param lm the associated layout manager
     * @param index the index
     */
   public Position(LayoutManager lm, int index) {
        this(lm);
        setIndex(index);
    }
    
Returns:
associated layout manager/** @return associated layout manager */
    public LayoutManager getLM() {
        return layoutManager;
    }

    
Params:
depth – the depth at which the LM in this position is found
Returns:
associated layout manager/**
     * @param depth the depth at which the LM in this position is found
     * @return associated layout manager
     */
    public LayoutManager getLM(int depth) {
        Position subPos = getPosition(depth);
        if (subPos == null) {
            return null;
        } else {
            return subPos.getLM();
        }
    }

    
Overridden by NonLeafPosition to return the Position of its child LM.
Returns:
a position or null/**
     * Overridden by NonLeafPosition to return the Position of its child LM.
     * @return a position or null
     */
    public Position getPosition() {
        return null;
    }

    
Overridden by NonLeafPosition to return the Position of its child LM.
Params:
depth – the depth at which the position in this position is found
Returns:
a position or null/**
     * Overridden by NonLeafPosition to return the Position of its child LM.
     * @param depth the depth at which the position in this position is found
     * @return a position or null
     */
    public Position getPosition(int depth) {
        Position subPos = this;
        for (int i = 0; i < depth && subPos != null; ++i, subPos = subPos.getPosition()) {
            // no-op
        }
        return subPos;
    }

    
Returns:
true if generates areas/** @return true if generates areas */
    public boolean generatesAreas() {
        return false;
    }

    
Sets the index of this position in the sequence of Position elements.
Params:
value – this position's index/**
     * Sets the index of this position in the sequence of Position elements.
     *
     * @param value this position's index
     */
    public void setIndex(int value) {
        this.index = value;
    }

    
Returns the index of this position in the sequence of Position elements.
Returns:
the index of this position in the sequence of Position elements/**
     * Returns the index of this position in the sequence of Position elements.
     *
     * @return the index of this position in the sequence of Position elements
     */
    public int getIndex() {
        return this.index;
    }

    
Returns:
short name of associated layout manager/** @return short name of associated layout manager */
    protected String getShortLMName() {
        if (getLM() != null) {
            String lm = getLM().toString();
            int idx = lm.lastIndexOf('.');
            if (idx >= 0 && lm.indexOf('@') > 0) {
                return lm.substring(idx + 1);
            } else {
                return lm;
            }
        } else {
            return "null";
        }
    }

    
{@inheritDoc} /** {@inheritDoc} */
    public String toString() {
        StringBuffer sb = new StringBuffer();
        sb.append("Position:").append(getIndex()).append("(");
        sb.append(getShortLMName());
        sb.append(")");
        return sb.toString();
    }
}