[ Index ]
 

Code source de Horde 3.1.3

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/lib/Horde/Block/Layout/ -> Manager.php (sommaire)

(pas de description)

Poids: 1396 lignes (47 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

Horde_Block_Layout_Manager:: (45 méthodes):
  Horde_Block_Layout_Manager()
  serialize()
  unserialize()
  singleton()
  handle()
  updated()
  getCurrentBlock()
  getBlock()
  getBlockAt()
  getBlockInfo()
  setBlockInfo()
  count()
  rows()
  columns()
  isEmpty()
  isCovered()
  isBlock()
  isChanged()
  isRemovable()
  getActionUrl()
  getControl()
  rowExists()
  colExists()
  getWidth()
  getHeight()
  addBlock()
  addRow()
  addCol()
  removeBlock()
  removeRowIfEmpty()
  removeColIfEmpty()
  moveUp()
  moveDown()
  moveDownBelow()
  moveLeft()
  moveRight()
  moveRightAfter()
  expandUp()
  expandDown()
  expandLeft()
  expandRight()
  shrinkUp()
  shrinkDown()
  shrinkLeft()
  shrinkRight()


Classe: Horde_Block_Layout_Manager  - X-Ref

The Horde_Block_Layout_Manager class allows manipulation of
Horde_Block layouts.

$Horde: framework/Block/Block/Layout/Manager.php,v 1.4.2.3 2006/03/08 17:54:08 chuck Exp $

Copyright 2003-2006 Mike Cochrane <mike@graftonhall.co.nz>
Copyright 2003-2006 Jan Schneider <jan@horde.org>

See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Horde_Block_Layout_Manager(&$collection, $data = '')   X-Ref
Constructor.

param: Horde_Block_Collection &$collection
param: string $data

serialize()   X-Ref
Serialize and return the current block layout.


unserialize($data)   X-Ref
Resets the current layout to the value stored in the preferences.


singleton($name, &$collection, $data = '')   X-Ref
Returns a single instance of the Horde_Block_Layout_Manager class.

param: string $name
param: Horde_Block_Collection &$collection
param: string $data
return: Horde_Block_Layout_Manager  The Horde_Block_Layout_Manager instance.

handle($action, $row, $col)   X-Ref
Process a modification to the current layout.


updated()   X-Ref
Has the layout been changed since it was instantiated?

return: boolean

getCurrentBlock()   X-Ref
Get the current block row and column.

return: array [row, col]

getBlock($row, $col)   X-Ref
Returns the Horde_Block at the specified position.

param: integer $row  A layout row.
param: integer $col  A layout column.
return: Horde_Block  The block from that position or a PEAR_Error

getBlockAt($row, $col)   X-Ref
Returns the coordinates of the block covering the specified
field.

param: integer $row  A layout row.
param: integer $col  A layout column.
return: array  The top-left row-column-coordinate of the block

getBlockInfo($row, $col)   X-Ref
Returns a hash with some useful information about the specified
block.

Returned hash values:
'app': application name
'block': block name
'params': parameter hash

param: integer $row  A layout row.
param: integer $col  A layout column.
return: array  The information hash.

setBlockInfo($row, $col, $info = array()   X-Ref
Sets a batch of information about the specified block.

param: integer $row  A layout row.
param: integer $col  A layout column.
param: array $info   A hash with information values.

count()   X-Ref
Returns the number of blocks in the current layout.

return: integer  The number of blocks.

rows()   X-Ref
Returns the number of rows in the current layout.

return: integer  The number of rows.

columns($row)   X-Ref
Returns the number of columns in the specified row of the
current layout.

param: integer $row  The row to return the number of columns from.
return: integer  The number of columns.

isEmpty($row, $col)   X-Ref
Checks to see if a given location if being used by a block

param: integer $row  A layout row.
param: integer $col  A layout column.
return: boolean  True if the location is empty

isCovered($row, $col)   X-Ref
Returns if the field at the specified position is covered by
another block.

param: integer $row  A layout row.
param: integer $col  A layout column.
return: boolean  True if the specified field is covered.

isBlock($row, $col)   X-Ref
Returns if the specified location is the top left field of
a block.

param: integer $row  A layout row.
param: integer $col  A layout column.
return: boolean  True if the specified position is a block, false if

isChanged($row, $col)   X-Ref
Returns if the specified block has been changed last.

param: integer $row  A layout row.
param: integer $col  A layout column.
return: boolean  True if this block is the last one that was changed.

isRemovable($row, $col)   X-Ref
Returns if the specified block may be removed.

param: integer $row  A layout row.
param: integer $col  A layout column.
return: boolean  True if this block may be removed.

getActionUrl($action, $row, $col)   X-Ref
Returns an URL triggering an action to a block

param: string $action  An action to trigger.
param: integer $row  A layout row.
param: integer $col  A layout column.
return: string  An URL with all necessary parameters.

getControl($type, $row, $col)   X-Ref
Returns a control (linked arrow) for a certain action on the
specified block.

param: string $type  A control type in the form
param: integer $row  A layout row.
param: integer $col  A layout column.
return: string  A link containing an arrow representing the requested

rowExists($row)   X-Ref
Does a row exist?

param: integer $row  The row to look for
return: boolean  True if the row exists

colExists($col)   X-Ref
Does a column exist?

param: integer $col  The column to look for
return: boolean  True if the column exists

getWidth($row, $col)   X-Ref
Get the width of the block at a given location.
This returns the width if there is a block at this
location, otherwise returns 1.

param: integer $row  A layout row.
param: integer $col  A layout column.
return: integer  The number of columns this block spans

getHeight($row, $col)   X-Ref
Get the height of the block at a given location.
This returns the height if there is a block at this
location, otherwise returns 1.

param: integer $row  A layout row.
param: integer $col  A layout column.
return: integer  The number of rows this block spans

addBlock($row, $col)   X-Ref
Adds an empty block at the specified position.

param: integer $row  A layout row.
param: integer $col  A layout column.

addRow($row)   X-Ref
Adds a new row to the layout.

param: integer $row  The number of the row to add

addCol($col)   X-Ref
Adds a new column to the layout.

param: integer $col  The number of the column to add

removeBlock($row, $col)   X-Ref
Removes a block.

param: integer $row  A layout row.
param: integer $col  A layout column.

removeRowIfEmpty($row)   X-Ref
Removes a row if it's empty.

param: integer $row  The number of the row to to check
return: boolean  True if the row is now removed.

removeColIfEmpty($col)   X-Ref
Removes a column if it's empty.

param: integer $col  The number of the column to to check
return: boolean  True if the column is now removed.

moveUp($row, $col)   X-Ref
Moves a block one row up.

param: integer $row  A layout row.
param: integer $col  A layout column.

moveDown($row, $col)   X-Ref
Moves a block one row down.

param: integer $row  A layout row.
param: integer $col  A layout column.

moveDownBelow($row)   X-Ref
Moves all blocks below a certain row one row down.

param: integer $row  A layout row.
return: boolean  True if all rows could be moved down.

moveLeft($row, $col)   X-Ref
Moves a block one column left.

param: integer $row  A layout row.
param: integer $col  A layout column.

moveRight($row, $col)   X-Ref
Moves a block one column right.

param: integer $row  A layout row.
param: integer $col  A layout column.

moveRightAfter($col)   X-Ref
Moves all blocks after a certain column one column right.

param: integer $col  A layout column.
return: boolean  True if all columns could be moved right.

expandUp($row, $col)   X-Ref
Makes a block one row taller by moving the top up.

param: integer $row  A layout row.
param: integer $col  A layout column.

expandDown($row, $col)   X-Ref
Makes a block one row taller by moving the bottom down.

param: integer $row  A layout row.
param: integer $col  A layout column.

expandLeft($row, $col)   X-Ref
Makes a block one column wider by moving the left side out.

param: integer $row  A layout row.
param: integer $col  A layout column.

expandRight($row, $col)   X-Ref
Makes a block one column wider by moving the right side out.

param: integer $row  A layout row.
param: integer $col  A layout column.

shrinkUp($row, $col)   X-Ref
Makes a block one row lower by moving the top down.

param: integer $row  A layout row.
param: integer $col  A layout column.

shrinkDown($row, $col)   X-Ref
Makes a block one row lower by moving the bottom up.

param: integer $row  A layout row.
param: integer $col  A layout column.

shrinkLeft($row, $col)   X-Ref
Makes a block one column narrower by moving the left side in.

param: integer $row  A layout row.
param: integer $col  A layout column.

shrinkRight($row, $col)   X-Ref
Makes a block one column narrower by moving the right side in.

param: integer $row  A layout row.
param: integer $col  A layout column.



Généré le : Sun Feb 25 18:01:28 2007 par Balluche grâce à PHPXref 0.7