org.fit.cssbox.layout.ReplacedContent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cssbox Show documentation

CSSBox is an (X)HTML/CSS rendering engine written in pure Java. Its primary purpose is to provide a complete information about the rendered page suitable for further processing. However, it also allows displaying the rendered document.

There is a newer version: 5.0.2

Show newest version

/**
 * ReplacedContent.java
 * Copyright (c) 2005-2007 Radek Burget
 *
 * CSSBox is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *  
 * CSSBox is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *  
 * You should have received a copy of the GNU Lesser General Public License
 * along with CSSBox. If not, see .
 *
 * Created on 27.9.2006, 21:15:03 by radek
 */
package org.fit.cssbox.layout;

import java.awt.Graphics2D;

/**
 * A class that represents the contents of a replace box
 * 
 * @author radek
 */
public abstract class ReplacedContent
{
	/** The owner box */
	protected ElementBox owner;
    
    /** Defined width (CSS syntax, e.g. "120px" or "auto") */
    protected String def_width;

    /** Defined height (CSS syntax, e.g. "120px" or "auto") */
    protected String def_height;
	
	//============================================================
	
	public ReplacedContent(ElementBox owner)
	{
		this.owner = owner;
	}
	
	/**
	 * @return the owner
	 */
	public ElementBox getOwner()
	{
		return owner;
	}

	/**
	 * @param owner the owner to set
	 */
	public void setOwner(ElementBox owner)
	{
		this.owner = owner;
	}

    /**
     * Loads the size definitions from appropriate node attributes or CSS properties
     */
    public void loadSizeDefs()
    {
        //default behaviour - set 'auto' only
        def_width = "auto";
        def_height = "auto";
    }
    
    /**
     * Compute the content layout in the owner area
     */
    public void doLayout()
    {
        //the default behaviour is to do remove the child nodes from the owner object if any
        //because the box is replaced by the content
        owner.removeAllSubBoxes();
    }
    
    /**
     * Computes the absolute positions in the content if necessary.
     */
    public void absolutePositions()
    {
        //the default is to do nothing
    }
    
	/**
	 * Draw the contents of the element.
	 * @param g graphics context
	 * @param width the required width of the result 
	 * @param height the required height of the result 
	 */
    abstract public void draw(Graphics2D g, int width, int height);
    
    /**
     * @return the intrinsic width of the contents
     */
    abstract public int getIntrinsicWidth();

    /**
     * @return the intrinsic height of the contents
     */
    abstract public int getIntrinsicHeight();

    /**
     * @return the intrinsic width/height ratio. If the object has no ratio, 0 is returned
     */
    abstract public float getIntrinsicRatio();
    
    
}