Class PBEObject

Object
  |
  +--PBEUnit
        |
        +--PBEObject

Direct Known Subclasses:

PBEContainer, PBELoginObject

public class PBEObject

extends PBEUnit

PBE Attributes/Fields:

pbe_error

PBE Methods:

init, display, clear, keep, revert

Examples:

 PBE:declareObject(
   "PBEObject",
   "globals");
 PBE:declareAttribute(
   "PBEAttribute",
   "mainpage");
 

This examples declares an instance of PBEObject called "global". This object is intended to keep global state of the application. Additionally an attribute called "mainpage" is declared for this object.

This example can be found in the file "initdemo.pbt" of the "PBE Demo" module (approx. line 152).

Field Summary

PBEAttribute[]	attributes
protected boolean	iClearInput
PBEMethod[]	methods
varchar	name

Constructor Summary

PBEObject(varchar name)

Method Summary

varchar	attributeName(varchar tag_name)
void	clear() Activate the 'clear' method of the object.
void	clearInput() Clear all input data for this object.
void	disable(varchar page) Disable all PBE methods of the object.
void	disableAttributes(varchar page) Disable all PBE attributes of the object.
void	display() Activate the 'display' method of the object.
void	enable() Enable all PBE methods of the object.
void	enableAttributes() Enable all PBE attributes of the object.
varchar	getAttributeStatus()
varchar	getAttributeStatus(varchar tag_name)
varchar	getError()
varchar	globalReference()
void	hide(varchar page) Hide all PBE attributes of the object.
boolean	init() Activate the 'init' method of the object.
void	inputMethod(varchar tag_name)
void	inputMethod(varchar tag_name, generic value, boolean is_first)
void	inputValue(varchar tag_name, generic value, boolean is_first)
generic	outputValue(varchar tag_name)
generic	outputValue(varchar tag_name, boolean is_edit)
generic	outputValue(varchar tag_name, boolean is_edit, generic default_value)
boolean	performActivation(varchar name)
void	prepareAction(varchar when, varchar what, varchar action)
void	redirect(varchar page) Disable the display method.
void	setActive(PBEMethod method)
void	setAttributeStatus(varchar tag_name, varchar err)
void	setError(generic status)
void	show() Show all PBE attributes of the object.

Methods inherited from class PBEUnit

compileActions, compileConditions, prepareEvent

Field Detail

name

public varchar name

attributes

public PBEAttribute[] attributes

methods

public PBEMethod[] methods

iClearInput

protected boolean iClearInput

Constructor Detail

PBEObject

public PBEObject(varchar name)

Parameters:

name - the name used to access this object.

Method Detail

globalReference

public varchar globalReference()

Overrides:

globalReference in class PBEUnit

prepareAction

public void prepareAction(varchar when,
                          varchar what,
                          varchar action)

Overrides:

prepareAction in class PBEUnit

redirect

public void redirect(varchar page)

Disable the display method. Set the page to which the user should be redirected to if an attempt is made to view this object.

enable

public void enable()

Enable all PBE methods of the object. Activation from Web user is allowed.

disable

public void disable(varchar page)

Disable all PBE methods of the object. Activation by the Web user is not allowed.

show

public void show()

Show all PBE attributes of the object.

hide

public void hide(varchar page)

Hide all PBE attributes of the object.

enableAttributes

public void enableAttributes()

Enable all PBE attributes of the object. Write from Web is allowed.

disableAttributes

public void disableAttributes(varchar page)

Disable all PBE attributes of the object. Write from Web is not allowed.

init

public boolean init()

Activate the 'init' method of the object.

display

public void display()

Activate the 'display' method of the object.

clear

public void clear()

Activate the 'clear' method of the object.

setError

public void setError(generic status)

getError

public varchar getError()

setActive

public void setActive(PBEMethod method)

performActivation

public boolean performActivation(varchar name)

clearInput

public void clearInput()

Clear all input data for this object.

attributeName

public varchar attributeName(varchar tag_name)

outputValue

public final generic outputValue(varchar tag_name)

outputValue

public final generic outputValue(varchar tag_name,
                                 boolean is_edit)

outputValue

public generic outputValue(varchar tag_name,
                           boolean is_edit,
                           generic default_value)

inputValue

public void inputValue(varchar tag_name,
                       generic value,
                       boolean is_first)

inputMethod

public final void inputMethod(varchar tag_name)

inputMethod

public void inputMethod(varchar tag_name,
                        generic value,
                        boolean is_first)

getAttributeStatus

public varchar getAttributeStatus(varchar tag_name)

setAttributeStatus

public void setAttributeStatus(varchar tag_name,
                               varchar err)

getAttributeStatus

public varchar getAttributeStatus()