You are here

Home » API reference » Loft Data Grids 6.2 » Alignment.php

class PHPExcel_Style_Alignment in Loft Data Grids 6.2

Same name and namespace in other branches
  1. 7.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/Style/Alignment.php \PHPExcel_Style_Alignment

PHPExcel_Style_Alignment

@category PHPExcel @package PHPExcel_Style @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

Hierarchy

Expanded class hierarchy of PHPExcel_Style_Alignment

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Style/Alignment.php, line 36

View source 
class PHPExcel_Style_Alignment extends PHPExcel_Style_Supervisor implements PHPExcel_IComparable {

  /* Horizontal alignment styles */
  const HORIZONTAL_GENERAL = 'general';
  const HORIZONTAL_LEFT = 'left';
  const HORIZONTAL_RIGHT = 'right';
  const HORIZONTAL_CENTER = 'center';
  const HORIZONTAL_CENTER_CONTINUOUS = 'centerContinuous';
  const HORIZONTAL_JUSTIFY = 'justify';
  const HORIZONTAL_FILL = 'fill';
  const HORIZONTAL_DISTRIBUTED = 'distributed';

  // Excel2007 only

  /* Vertical alignment styles */
  const VERTICAL_BOTTOM = 'bottom';
  const VERTICAL_TOP = 'top';
  const VERTICAL_CENTER = 'center';
  const VERTICAL_JUSTIFY = 'justify';
  const VERTICAL_DISTRIBUTED = 'distributed';

  // Excel2007 only

  /* Read order */
  const READORDER_CONTEXT = 0;
  const READORDER_LTR = 1;
  const READORDER_RTL = 2;

  /**
   * Horizontal alignment
   *
   * @var string
   */
  protected $_horizontal = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL;

  /**
   * Vertical alignment
   *
   * @var string
   */
  protected $_vertical = PHPExcel_Style_Alignment::VERTICAL_BOTTOM;

  /**
   * Text rotation
   *
   * @var integer
   */
  protected $_textRotation = 0;

  /**
   * Wrap text
   *
   * @var boolean
   */
  protected $_wrapText = FALSE;

  /**
   * Shrink to fit
   *
   * @var boolean
   */
  protected $_shrinkToFit = FALSE;

  /**
   * Indent - only possible with horizontal alignment left and right
   *
   * @var integer
   */
  protected $_indent = 0;

  /**
   * Read order
   *
   * @var integer
   */
  protected $_readorder = 0;

  /**
   * Create a new PHPExcel_Style_Alignment
   *
   * @param	boolean	$isSupervisor	Flag indicating if this is a supervisor or not
   *									Leave this value at default unless you understand exactly what
   *										its ramifications are
   * @param	boolean	$isConditional	Flag indicating if this is a conditional style or not
   *									Leave this value at default unless you understand exactly what
   *										its ramifications are
   */
  public function __construct($isSupervisor = FALSE, $isConditional = FALSE) {

    // Supervisor?
    parent::__construct($isSupervisor);
    if ($isConditional) {
      $this->_horizontal = NULL;
      $this->_vertical = NULL;
      $this->_textRotation = NULL;
    }
  }

  /**
   * Get the shared style component for the currently active cell in currently active sheet.
   * Only used for style supervisor
   *
   * @return PHPExcel_Style_Alignment
   */
  public function getSharedComponent() {
    return $this->_parent
      ->getSharedComponent()
      ->getAlignment();
  }

  /**
   * Build style array from subcomponents
   *
   * @param array $array
   * @return array
   */
  public function getStyleArray($array) {
    return array(
      'alignment' => $array,
    );
  }

  /**
   * Apply styles from array
   *
   * <code>
   * $objPHPExcel->getActiveSheet()->getStyle('B2')->getAlignment()->applyFromArray(
   *		array(
   *			'horizontal' => PHPExcel_Style_Alignment::HORIZONTAL_CENTER,
   *			'vertical'   => PHPExcel_Style_Alignment::VERTICAL_CENTER,
   *			'rotation'   => 0,
   *			'wrap'			=> TRUE
   *		)
   * );
   * </code>
   *
   * @param	array	$pStyles	Array containing style information
   * @throws	PHPExcel_Exception
   * @return PHPExcel_Style_Alignment
   */
  public function applyFromArray($pStyles = NULL) {
    if (is_array($pStyles)) {
      if ($this->_isSupervisor) {
        $this
          ->getActiveSheet()
          ->getStyle($this
          ->getSelectedCells())
          ->applyFromArray($this
          ->getStyleArray($pStyles));
      }
      else {
        if (isset($pStyles['horizontal'])) {
          $this
            ->setHorizontal($pStyles['horizontal']);
        }
        if (isset($pStyles['vertical'])) {
          $this
            ->setVertical($pStyles['vertical']);
        }
        if (isset($pStyles['rotation'])) {
          $this
            ->setTextRotation($pStyles['rotation']);
        }
        if (isset($pStyles['wrap'])) {
          $this
            ->setWrapText($pStyles['wrap']);
        }
        if (isset($pStyles['shrinkToFit'])) {
          $this
            ->setShrinkToFit($pStyles['shrinkToFit']);
        }
        if (isset($pStyles['indent'])) {
          $this
            ->setIndent($pStyles['indent']);
        }
        if (isset($pStyles['readorder'])) {
          $this
            ->setReadorder($pStyles['readorder']);
        }
      }
    }
    else {
      throw new PHPExcel_Exception("Invalid style array passed.");
    }
    return $this;
  }

  /**
   * Get Horizontal
   *
   * @return string
   */
  public function getHorizontal() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getHorizontal();
    }
    return $this->_horizontal;
  }

  /**
   * Set Horizontal
   *
   * @param string $pValue
   * @return PHPExcel_Style_Alignment
   */
  public function setHorizontal($pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL) {
    if ($pValue == '') {
      $pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL;
    }
    if ($this->_isSupervisor) {
      $styleArray = $this
        ->getStyleArray(array(
        'horizontal' => $pValue,
      ));
      $this
        ->getActiveSheet()
        ->getStyle($this
        ->getSelectedCells())
        ->applyFromArray($styleArray);
    }
    else {
      $this->_horizontal = $pValue;
    }
    return $this;
  }

  /**
   * Get Vertical
   *
   * @return string
   */
  public function getVertical() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getVertical();
    }
    return $this->_vertical;
  }

  /**
   * Set Vertical
   *
   * @param string $pValue
   * @return PHPExcel_Style_Alignment
   */
  public function setVertical($pValue = PHPExcel_Style_Alignment::VERTICAL_BOTTOM) {
    if ($pValue == '') {
      $pValue = PHPExcel_Style_Alignment::VERTICAL_BOTTOM;
    }
    if ($this->_isSupervisor) {
      $styleArray = $this
        ->getStyleArray(array(
        'vertical' => $pValue,
      ));
      $this
        ->getActiveSheet()
        ->getStyle($this
        ->getSelectedCells())
        ->applyFromArray($styleArray);
    }
    else {
      $this->_vertical = $pValue;
    }
    return $this;
  }

  /**
   * Get TextRotation
   *
   * @return int
   */
  public function getTextRotation() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getTextRotation();
    }
    return $this->_textRotation;
  }

  /**
   * Set TextRotation
   *
   * @param int $pValue
   * @throws PHPExcel_Exception
   * @return PHPExcel_Style_Alignment
   */
  public function setTextRotation($pValue = 0) {

    // Excel2007 value 255 => PHPExcel value -165
    if ($pValue == 255) {
      $pValue = -165;
    }

    // Set rotation
    if ($pValue >= -90 && $pValue <= 90 || $pValue == -165) {
      if ($this->_isSupervisor) {
        $styleArray = $this
          ->getStyleArray(array(
          'rotation' => $pValue,
        ));
        $this
          ->getActiveSheet()
          ->getStyle($this
          ->getSelectedCells())
          ->applyFromArray($styleArray);
      }
      else {
        $this->_textRotation = $pValue;
      }
    }
    else {
      throw new PHPExcel_Exception("Text rotation should be a value between -90 and 90.");
    }
    return $this;
  }

  /**
   * Get Wrap Text
   *
   * @return boolean
   */
  public function getWrapText() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getWrapText();
    }
    return $this->_wrapText;
  }

  /**
   * Set Wrap Text
   *
   * @param boolean $pValue
   * @return PHPExcel_Style_Alignment
   */
  public function setWrapText($pValue = FALSE) {
    if ($pValue == '') {
      $pValue = FALSE;
    }
    if ($this->_isSupervisor) {
      $styleArray = $this
        ->getStyleArray(array(
        'wrap' => $pValue,
      ));
      $this
        ->getActiveSheet()
        ->getStyle($this
        ->getSelectedCells())
        ->applyFromArray($styleArray);
    }
    else {
      $this->_wrapText = $pValue;
    }
    return $this;
  }

  /**
   * Get Shrink to fit
   *
   * @return boolean
   */
  public function getShrinkToFit() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getShrinkToFit();
    }
    return $this->_shrinkToFit;
  }

  /**
   * Set Shrink to fit
   *
   * @param boolean $pValue
   * @return PHPExcel_Style_Alignment
   */
  public function setShrinkToFit($pValue = FALSE) {
    if ($pValue == '') {
      $pValue = FALSE;
    }
    if ($this->_isSupervisor) {
      $styleArray = $this
        ->getStyleArray(array(
        'shrinkToFit' => $pValue,
      ));
      $this
        ->getActiveSheet()
        ->getStyle($this
        ->getSelectedCells())
        ->applyFromArray($styleArray);
    }
    else {
      $this->_shrinkToFit = $pValue;
    }
    return $this;
  }

  /**
   * Get indent
   *
   * @return int
   */
  public function getIndent() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getIndent();
    }
    return $this->_indent;
  }

  /**
   * Set indent
   *
   * @param int $pValue
   * @return PHPExcel_Style_Alignment
   */
  public function setIndent($pValue = 0) {
    if ($pValue > 0) {
      if ($this
        ->getHorizontal() != self::HORIZONTAL_GENERAL && $this
        ->getHorizontal() != self::HORIZONTAL_LEFT && $this
        ->getHorizontal() != self::HORIZONTAL_RIGHT) {
        $pValue = 0;

        // indent not supported
      }
    }
    if ($this->_isSupervisor) {
      $styleArray = $this
        ->getStyleArray(array(
        'indent' => $pValue,
      ));
      $this
        ->getActiveSheet()
        ->getStyle($this
        ->getSelectedCells())
        ->applyFromArray($styleArray);
    }
    else {
      $this->_indent = $pValue;
    }
    return $this;
  }

  /**
   * Get read order
   *
   * @return integer
   */
  public function getReadorder() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getReadorder();
    }
    return $this->_readorder;
  }

  /**
   * Set read order
   *
   * @param int $pValue
   * @return PHPExcel_Style_Alignment
   */
  public function setReadorder($pValue = 0) {
    if ($pValue < 0 || $pValue > 2) {
      $pValue = 0;
    }
    if ($this->_isSupervisor) {
      $styleArray = $this
        ->getStyleArray(array(
        'readorder' => $pValue,
      ));
      $this
        ->getActiveSheet()
        ->getStyle($this
        ->getSelectedCells())
        ->applyFromArray($styleArray);
    }
    else {
      $this->_readorder = $pValue;
    }
    return $this;
  }

  /**
   * Get hash code
   *
   * @return string	Hash code
   */
  public function getHashCode() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getHashCode();
    }
    return md5($this->_horizontal . $this->_vertical . $this->_textRotation . ($this->_wrapText ? 't' : 'f') . ($this->_shrinkToFit ? 't' : 'f') . $this->_indent . $this->_readorder . __CLASS__);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPExcel_Style_Alignment::$_horizontal protected property * Horizontal alignment * *
PHPExcel_Style_Alignment::$_indent protected property * Indent - only possible with horizontal alignment left and right * *
PHPExcel_Style_Alignment::$_readorder protected property * Read order * *
PHPExcel_Style_Alignment::$_shrinkToFit protected property * Shrink to fit * *
PHPExcel_Style_Alignment::$_textRotation protected property * Text rotation * *
PHPExcel_Style_Alignment::$_vertical protected property * Vertical alignment * *
PHPExcel_Style_Alignment::$_wrapText protected property * Wrap text * *
PHPExcel_Style_Alignment::applyFromArray public function * Apply styles from array * * <code> * $objPHPExcel->getActiveSheet()->getStyle('B2')->getAlignment()->applyFromArray( * array( * 'horizontal' => PHPExcel_Style_Alignment::HORIZONTAL_CENTER, …
PHPExcel_Style_Alignment::getHashCode public function * Get hash code * * Overrides PHPExcel_IComparable::getHashCode
PHPExcel_Style_Alignment::getHorizontal public function * Get Horizontal * *
PHPExcel_Style_Alignment::getIndent public function * Get indent * *
PHPExcel_Style_Alignment::getReadorder public function * Get read order * *
PHPExcel_Style_Alignment::getSharedComponent public function * Get the shared style component for the currently active cell in currently active sheet. * Only used for style supervisor * *
PHPExcel_Style_Alignment::getShrinkToFit public function * Get Shrink to fit * *
PHPExcel_Style_Alignment::getStyleArray public function * Build style array from subcomponents * *
PHPExcel_Style_Alignment::getTextRotation public function * Get TextRotation * *
PHPExcel_Style_Alignment::getVertical public function * Get Vertical * *
PHPExcel_Style_Alignment::getWrapText public function * Get Wrap Text * *
PHPExcel_Style_Alignment::HORIZONTAL_CENTER constant
PHPExcel_Style_Alignment::HORIZONTAL_CENTER_CONTINUOUS constant
PHPExcel_Style_Alignment::HORIZONTAL_DISTRIBUTED constant
PHPExcel_Style_Alignment::HORIZONTAL_FILL constant
PHPExcel_Style_Alignment::HORIZONTAL_GENERAL constant
PHPExcel_Style_Alignment::HORIZONTAL_JUSTIFY constant
PHPExcel_Style_Alignment::HORIZONTAL_LEFT constant
PHPExcel_Style_Alignment::HORIZONTAL_RIGHT constant
PHPExcel_Style_Alignment::READORDER_CONTEXT constant
PHPExcel_Style_Alignment::READORDER_LTR constant
PHPExcel_Style_Alignment::READORDER_RTL constant
PHPExcel_Style_Alignment::setHorizontal public function * Set Horizontal * *
PHPExcel_Style_Alignment::setIndent public function * Set indent * *
PHPExcel_Style_Alignment::setReadorder public function * Set read order * *
PHPExcel_Style_Alignment::setShrinkToFit public function * Set Shrink to fit * *
PHPExcel_Style_Alignment::setTextRotation public function * Set TextRotation * *
PHPExcel_Style_Alignment::setVertical public function * Set Vertical * *
PHPExcel_Style_Alignment::setWrapText public function * Set Wrap Text * *
PHPExcel_Style_Alignment::VERTICAL_BOTTOM constant
PHPExcel_Style_Alignment::VERTICAL_CENTER constant
PHPExcel_Style_Alignment::VERTICAL_DISTRIBUTED constant
PHPExcel_Style_Alignment::VERTICAL_JUSTIFY constant
PHPExcel_Style_Alignment::VERTICAL_TOP constant
PHPExcel_Style_Alignment::__construct public function * Create a new PHPExcel_Style_Alignment * * Overrides PHPExcel_Style_Supervisor::__construct
PHPExcel_Style_Supervisor::$_isSupervisor protected property * Supervisor? * *
PHPExcel_Style_Supervisor::$_parent protected property * Parent. Only used for supervisor * *
PHPExcel_Style_Supervisor::bindParent public function * Bind parent. Only used for supervisor * * 2
PHPExcel_Style_Supervisor::getActiveCell public function * Get the currently active cell coordinate in currently active sheet. * Only used for supervisor * *
PHPExcel_Style_Supervisor::getActiveSheet public function * Get the currently active sheet. Only used for supervisor * *
PHPExcel_Style_Supervisor::getIsSupervisor public function * Is this a supervisor or a cell style component? * *
PHPExcel_Style_Supervisor::getSelectedCells public function * Get the currently active cell coordinate in currently active sheet. * Only used for supervisor * *
PHPExcel_Style_Supervisor::__clone public function * Implement PHP __clone to create a deep clone, not just a shallow copy.