source: sourcecode/application/libraries/PHPExcel/Chart/Legend.php @ 1

<?php
/**
 * PHPExcel
 *
 * Copyright (c) 2006 - 2014 PHPExcel
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @category    PHPExcel
 * @package             PHPExcel_Chart
 * @copyright   Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
 * @license             http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt   LGPL
 * @version             1.8.0, 2014-03-02
 */


/**
 * PHPExcel_Chart_Legend
 *
 * @category    PHPExcel
 * @package             PHPExcel_Chart
 * @copyright   Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
 */
class PHPExcel_Chart_Legend
{
        /** Legend positions */
        const xlLegendPositionBottom    = -4107;        //      Below the chart.
        const xlLegendPositionCorner    = 2;            //      In the upper right-hand corner of the chart border.
        const xlLegendPositionCustom    = -4161;        //      A custom position.
        const xlLegendPositionLeft              = -4131;        //      Left of the chart.
        const xlLegendPositionRight             = -4152;        //      Right of the chart.
        const xlLegendPositionTop               = -4160;        //      Above the chart.

        const POSITION_RIGHT    = 'r';
        const POSITION_LEFT             = 'l';
        const POSITION_BOTTOM   = 'b';
        const POSITION_TOP              = 't';
        const POSITION_TOPRIGHT = 'tr';

        private static $_positionXLref = array( self::xlLegendPositionBottom    => self::POSITION_BOTTOM,
                                                                                        self::xlLegendPositionCorner    => self::POSITION_TOPRIGHT,
                                                                                        self::xlLegendPositionCustom    => '??',
                                                                                        self::xlLegendPositionLeft              => self::POSITION_LEFT,
                                                                                        self::xlLegendPositionRight             => self::POSITION_RIGHT,
                                                                                        self::xlLegendPositionTop               => self::POSITION_TOP
                                                                                  );

        /**
         * Legend position
         *
         * @var string
         */
        private $_position = self::POSITION_RIGHT;

        /**
         * Allow overlay of other elements?
         *
         * @var boolean
         */
        private $_overlay = TRUE;

        /**
         * Legend Layout
         *
         * @var PHPExcel_Chart_Layout
         */
        private $_layout = NULL;


        /**
         *      Create a new PHPExcel_Chart_Legend
         */
        public function __construct($position = self::POSITION_RIGHT, PHPExcel_Chart_Layout $layout = NULL, $overlay = FALSE)
        {
                $this->setPosition($position);
                $this->_layout = $layout;
                $this->setOverlay($overlay);
        }

        /**
         * Get legend position as an excel string value
         *
         * @return      string
         */
        public function getPosition() {
                return $this->_position;
        }

        /**
         * Get legend position using an excel string value
         *
         * @param       string  $position
         */
        public function setPosition($position = self::POSITION_RIGHT) {
                if (!in_array($position,self::$_positionXLref)) {
                        return false;
                }

                $this->_position = $position;
                return true;
        }

        /**
         * Get legend position as an Excel internal numeric value
         *
         * @return      number
         */
        public function getPositionXL() {
                return array_search($this->_position,self::$_positionXLref);
        }

        /**
         * Set legend position using an Excel internal numeric value
         *
         * @param       number  $positionXL
         */
        public function setPositionXL($positionXL = self::xlLegendPositionRight) {
                if (!array_key_exists($positionXL,self::$_positionXLref)) {
                        return false;
                }

                $this->_position = self::$_positionXLref[$positionXL];
                return true;
        }

        /**
         * Get allow overlay of other elements?
         *
         * @return      boolean
         */
        public function getOverlay() {
                return $this->_overlay;
        }

        /**
         * Set allow overlay of other elements?
         *
         * @param       boolean $overlay
         * @return      boolean
         */
        public function setOverlay($overlay = FALSE) {
                if (!is_bool($overlay)) {
                        return false;
                }

                $this->_overlay = $overlay;
                return true;
        }

        /**
         * Get Layout
         *
         * @return PHPExcel_Chart_Layout
         */
        public function getLayout() {
                return $this->_layout;
        }

}