class Base

Provided By: draw.feh

All types of images and documents extends this class

class contents [NB. Highlighted attributes are static members]
Functions
function getHeight() - Get the height of the document
function getMarginBottom() - Get the bottom margin
function getMarginLeft() - Get the left margin
function getMarginRight() - Get the right margin
function getMarginTop() - Get the top margin
function getWidth() - Get the width of the image or document
function newPage() - Begins a new page in a document
function renderItem(object) - Render an item to the image or document
function renderItems(array) - Render an array of items
function setBackground(string) - Set the background for the image or document
function setMargin(number) - Set the top, bottom, left and right margin
function setMarginBottom(number) - Set the bottom margin for the image or document
function setMarginLeft(number) - Set the left margin for the image or document
function setMarginRight(number) - set the right margin for the image or document
function setMarginTop(number) - Set the top margin for the image or document

Functions
function getHeight Click to go up to the list
Get the height of the document
Declaration:
    function getHeight( )
Returns:
    The height of the document

function getMarginBottom Click to go up to the list
Get the bottom margin
Declaration:
    function getMarginBottom( )
Returns:
    The bottom margin

function getMarginLeft Click to go up to the list
Get the left margin
Declaration:
    function getMarginLeft( )
Returns:
    The left margin

function getMarginRight Click to go up to the list
Get the right margin
Declaration:
    function getMarginRight( )
Returns:
    The right margin

function getMarginTop Click to go up to the list
Get the top margin
Declaration:
    function getMarginTop( )
Returns:
    The top margin

function getWidth Click to go up to the list
Get the width of the image or document
Declaration:
    function getWidth( )
Returns:
    The width of the image or document

function newPage Click to go up to the list
Begins a new page in a document
Declaration:
    function newPage( )

function renderItem Click to go up to the list
Render an item to the image or document
Declaration:
    function renderItem( object item )
Parameters:
    Parameter #1: object item - the item that should be rendered

function renderItems Click to go up to the list
Render an array of items
Declaration:
    function renderItems( array items )
Parameters:
    Parameter #1: array items - an array of items that should be rendered

function setBackground Click to go up to the list
Set the background for the image or document
Declaration:
    function setBackground( string background )
Parameters:
    Parameter #1: string background - the background

function setMargin Click to go up to the list
Set the top, bottom, left and right margin
Declaration:
    function setMargin( number margin )
Parameters:
    Parameter #1: number margin - the top, bottom, left and right margin

function setMarginBottom Click to go up to the list
Set the bottom margin for the image or document
Declaration:
    function setMarginBottom( number marginBottom )
Parameters:
    Parameter #1: number marginBottom - The bottom margin

function setMarginLeft Click to go up to the list
Set the left margin for the image or document
Declaration:
    function setMarginLeft( number numberLeft )
Parameters:
    Parameter #1: number marginLeft - The left margin

function setMarginRight Click to go up to the list
set the right margin for the image or document
Declaration:
    function setMarginRight( number marginRight )
Parameters:
    Parameter #1: number marginRight - The right margin

function setMarginTop Click to go up to the list
Set the top margin for the image or document
Declaration:
    function setMarginTop( number marginTop )
Parameters:
    Parameter #1: number marginTop - The top margin

Automatically generated at 10:10AM, Friday 05 November 2010 by feritedoc.