WACT_COMPONENT
[ class tree: WACT_COMPONENT ] [ index: WACT_COMPONENT ] [ all elements ]

Class: BlockComponent

Source Location: /framework/template/components/core/block.inc.php

http://wact.sourceforge.net/index.php/BlockComponent

Class Overview

Component
   |
   --BlockComponent

The block tag can be used to show or hide the contents of the block.

Variables

Methods


Child classes:

HtmlBaseComponent
Base class for HTML component tags

Inherited Variables

Inherited Methods

Class: Component

Component::addChild()
Adds a reference to a child component to this component, using it's ID attribute as the child array key
Component::findChild()
Returns a child component given it's ID.
Component::findChildByClass()
Returns the first child component matching the supplied WACT_TEMPLATE Component PHP class name
Component::findParentByClass()
Recursively searches through parents of this component searching for a given WACT_TEMPLATE component PHP class name
Component::getChild()
Same as find child, except raises error if child is not found
Component::getServerId()
Returns the ID of the component, as defined in the template tags ID attribute
Component::render()
Outputs the component, rendering any child components as well This method will only ever be called on components that support Dynamic rendering.
Component::setChildDataSource()
set the data source of a child component, or raise an error if the child is not found.

Class Details

The block tag can be used to show or hide the contents of the block.

The BlockComponent provides an API which allows the block to be shown or hidden at runtime.


Class Variables


$visible = TRUE

Whether the block is visible or not
access:  private
Type:   boolean

Class Methods


method hide

Changes the block state to invisible

void hide( )

API Tags:

access:  public

method IsVisible

Called within the compiled template render function to determine whether block should be displayed.

boolean IsVisible( )

API Tags:

return:  current state of the block
access:  protected

method show

Changes the block state to visible

void show( )

API Tags:

access:  public
WACT: Copyright 2003 Procata, Inc. Released under the LGPL license (http://www.gnu.org/copyleft/lesser.html)
Documentation generated on Sun, 28 Nov 2004 19:44:12 -0800 by phpDocumentor 1.2.3