PHPExcel_Style
[ class tree: PHPExcel_Style ] [ index: PHPExcel_Style ] [ all elements ]
Packages:
default
com-tecnick-tcpdf
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Best_Fit
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
Alignment.php
Border.php
Borders.php
Color.php
Conditional.php
Fill.php
Font.php
NumberFormat.php
Protection.php
Style.php

Classes:
PHPExcel_Style
PHPExcel_Style_Alignment
PHPExcel_Style_Border
PHPExcel_Style_Borders
PHPExcel_Style_Color
PHPExcel_Style_Conditional
PHPExcel_Style_Fill
PHPExcel_Style_Font
PHPExcel_Style_NumberFormat
PHPExcel_Style_Protection

Class: PHPExcel_Style_Protection

Source Location: /PHPExcel/Style/Protection.php

Class Overview




PHPExcel_Style_Protection




Author(s):


    
        





      
  


Copyright:


    
  
  • Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
    • 


                

            Implements interfaces:
            

        

        




Variables






Constants






Methods
























Class Details



[line 48]

PHPExcel_Style_Protection

PHPExcel_Style_Protection





Tags:





  

    copyright:  Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
  










[ Top ]







Class Variables



	
	

	
$_hidden = 

	
[line 67]

  Hidden

Hidden





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_isSupervisor = 

	
[line 81]

  Supervisor?

Supervisor?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_locked = 

	
[line 60]

  Locked

Locked





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 88]

  Parent.

Parent. Only used for supervisor





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style
    

      

	



	
[ Top ]


	
	

	
$_parentPropertyName = 

	
[line 74]

  Parent Borders

Parent Borders





Tags:





  

    var:  string
  

  

    access:  private
  






  

	

  

    

      Type:  
      _parentPropertyName
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 93]

	

    

    

		PHPExcel_Style_Protection __construct(
[
$isSupervisor = false])
    

    


	
		Create a new PHPExcel_Style_Protection

Create a new PHPExcel_Style_Protection





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $isSupervisor  
        
      

        

    


        
[ Top ]

  

  

	
	
method applyFromArray [line 190]

	

    

    

		PHPExcel_Style_Protection applyFromArray(
[array
$pStyles = null])
    

    


	
		Apply styles from array

Apply styles from array
 
  1.  $objPHPExcel->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray( array('locked' => true, 'hidden' => false) );
    2. 






Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $pStyles  
        Array containing style information
      

        

    


        
[ Top ]

  

  

	
	
method bindParent [line 109]

	

    

    

		PHPExcel_Style_Protection bindParent(
PHPExcel_Style
$parent)
    

    


	
		Bind parent.

Bind parent. Only used for supervisor





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style  
        $parent  
        
      

        

    


        
[ Top ]

  

  

	
	
method getActiveCell [line 163]

	

    

    

		string getActiveCell(
)
    

    


	
		Get the currently active cell coordinate in currently active sheet.

Get the currently active cell coordinate in currently active sheet. Only used for supervisor





Tags:





  

    return:  E.g. 'A1'
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getActiveSheet [line 141]

	

    

    

		PHPExcel_Worksheet getActiveSheet(
)
    

    


	
		Get the currently active sheet.

Get the currently active sheet. Only used for supervisor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 269]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHidden [line 241]

	

    

    

		string getHidden(
)
    

    


	
		Get hidden

Get hidden





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getIsSupervisor [line 120]

	

    

    

		boolean getIsSupervisor(
)
    

    


	
		Is this a supervisor or a real style component?

Is this a supervisor or a real style component?





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLocked [line 213]

	

    

    

		string getLocked(
)
    

    


	
		Get locked

Get locked





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSelectedCells [line 152]

	

    

    

		string getSelectedCells(
)
    

    


	
		Get the currently active cell coordinate in currently active sheet.

Get the currently active cell coordinate in currently active sheet. Only used for supervisor





Tags:





  

    return:  E.g. 'A1'
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSharedComponent [line 131]

	

    

    

		PHPExcel_Style_Protection getSharedComponent(
)
    

    


	
		Get the shared style component for the currently active cell in currently active sheet.

Get the shared style component for the currently active cell in currently active sheet. Only used for style supervisor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getStyleArray [line 174]

	

    

    

		array getStyleArray(
array
$array)
    

    


	
		Build style array from subcomponents

Build style array from subcomponents





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $array  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHidden [line 254]

	

    

    

		PHPExcel_Style_Protection setHidden(
[string
$pValue = self::PROTECTION_INHERIT])
    

    


	
		Set hidden

Set hidden





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setLocked [line 226]

	

    

    

		PHPExcel_Style_Protection setLocked(
[string
$pValue = self::PROTECTION_INHERIT])
    

    


	
		Set locked

Set locked





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 283]

	

    

    

		void __clone(
)
    

    


	
		Implement PHP __clone to create a deep clone, not just a shallow copy.

Implement PHP __clone to create a deep clone, not just a shallow copy.





Tags:





  

    access:  public
  









	
        
[ Top ]

  









Class Constants



	
	

	
PROTECTION_INHERIT =  'inherit'

	
[line 51]

  Protection styles

Protection styles


  

	
[ Top ]


	
	

	
PROTECTION_PROTECTED =  'protected'

	
[line 52]

  
  

	
[ Top ]


	
	

	
PROTECTION_UNPROTECTED =  'unprotected'

	
[line 53]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 11 Jan 2010 08:13:04 +0100 by phpDocumentor 1.4.1