com.eteks.sweethome3d.model

Class HomePrint

java.lang.Object

com.eteks.sweethome3d.model.HomePrint

All Implemented Interfaces:

java.io.Serializable

public class HomePrint
extends java.lang.Object
implements java.io.Serializable

The print attributes for a home.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HomePrint.PaperOrientation Paper orientation.

Constructor Summary

Constructors

Constructor and Description
HomePrint(HomePrint.PaperOrientation paperOrientation, float paperWidth, float paperHeight, float paperTopMargin, float paperLeftMargin, float paperBottomMargin, float paperRightMargin, boolean furniturePrinted, boolean planPrinted, boolean view3DPrinted, java.lang.Float planScale, java.lang.String headerFormat, java.lang.String footerFormat) Create a print attributes for home from the given parameters.
HomePrint(HomePrint.PaperOrientation paperOrientation, float paperWidth, float paperHeight, float paperTopMargin, float paperLeftMargin, float paperBottomMargin, float paperRightMargin, boolean furniturePrinted, boolean planPrinted, java.util.List<Level> printedLevels, boolean view3DPrinted, java.lang.Float planScale, java.lang.String headerFormat, java.lang.String footerFormat) Create a print attributes for home from the given parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFooterFormat() Returns the string format used to print page footers.
java.lang.String	getHeaderFormat() Returns the string format used to print page headers.
float	getPaperBottomMargin() Returns the margin at paper bottom in 1/72nds of an inch.
float	getPaperHeight() Returns the paper height in 1/72nds of an inch.
float	getPaperLeftMargin() Returns the margin at paper left in 1/72nds of an inch.
HomePrint.PaperOrientation	getPaperOrientation() Returns the paper orientation.
float	getPaperRightMargin() Returns the margin at paper right in 1/72nds of an inch.
float	getPaperTopMargin() Returns the margin at paper top in 1/72nds of an inch.
float	getPaperWidth() Returns the paper width in 1/72nds of an inch.
java.lang.Float	getPlanScale() Returns the scale used to print home plan or null if no special scale is desired.
java.util.List<Level>	getPrintedLevels() Returns the printed levels or null if all levels should be printed.
boolean	isFurniturePrinted() Returns whether home furniture should be printed or not.
boolean	isPlanPrinted() Returns whether home plan should be printed or not.
boolean	isView3DPrinted() Returns whether home 3D view should be printed or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HomePrint

public HomePrint(HomePrint.PaperOrientation paperOrientation,
                 float paperWidth,
                 float paperHeight,
                 float paperTopMargin,
                 float paperLeftMargin,
                 float paperBottomMargin,
                 float paperRightMargin,
                 boolean furniturePrinted,
                 boolean planPrinted,
                 boolean view3DPrinted,
                 java.lang.Float planScale,
                 java.lang.String headerFormat,
                 java.lang.String footerFormat)

Create a print attributes for home from the given parameters.

HomePrint

public HomePrint(HomePrint.PaperOrientation paperOrientation,
                 float paperWidth,
                 float paperHeight,
                 float paperTopMargin,
                 float paperLeftMargin,
                 float paperBottomMargin,
                 float paperRightMargin,
                 boolean furniturePrinted,
                 boolean planPrinted,
                 java.util.List<Level> printedLevels,
                 boolean view3DPrinted,
                 java.lang.Float planScale,
                 java.lang.String headerFormat,
                 java.lang.String footerFormat)

Create a print attributes for home from the given parameters.

Since:

7.2

Method Detail

getPaperOrientation

public HomePrint.PaperOrientation getPaperOrientation()

Returns the paper orientation.

getPaperBottomMargin

public float getPaperBottomMargin()

Returns the margin at paper bottom in 1/72nds of an inch.

getPaperHeight

public float getPaperHeight()

Returns the paper height in 1/72nds of an inch.

getPaperLeftMargin

public float getPaperLeftMargin()

Returns the margin at paper left in 1/72nds of an inch.

getPaperRightMargin

public float getPaperRightMargin()

Returns the margin at paper right in 1/72nds of an inch.

getPaperTopMargin

public float getPaperTopMargin()

Returns the margin at paper top in 1/72nds of an inch.

getPaperWidth

public float getPaperWidth()

Returns the paper width in 1/72nds of an inch.

isFurniturePrinted

public boolean isFurniturePrinted()

Returns whether home furniture should be printed or not.

isPlanPrinted

public boolean isPlanPrinted()

Returns whether home plan should be printed or not.

getPrintedLevels

public java.util.List<Level> getPrintedLevels()

Returns the printed levels or null if all levels should be printed.

Since:

7.2

isView3DPrinted

public boolean isView3DPrinted()

Returns whether home 3D view should be printed or not.

getPlanScale

public java.lang.Float getPlanScale()

Returns the scale used to print home plan or null if no special scale is desired.

getHeaderFormat

public java.lang.String getHeaderFormat()

Returns the string format used to print page headers.

getFooterFormat

public java.lang.String getFooterFormat()

Returns the string format used to print page footers.