JPane

Extends \JObject

JPane abstract class

abstract deprecated

This class allows for simple but smart objects with get and set methods and an internal error handler.

package

Joomla.Platform

subpackage

HTML

since

11.1

deprecated

12.1 Use JHtml::_ static helpers

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

11.1

Arguments

$properties

mixedEither and associative array or another object to set the initial properties of the object.

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

11.1

deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

_loadBehavior

Load the javascript behavior and attach it to the document.

_loadBehavior() : void
abstract deprecated
deprecated

12.1

since

11.1

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

endPane

Ends the pane.

endPane() : string
abstract deprecated
since

11.1

deprecated

12.1

Response

string

endPanel

Ends a panel.

endPanel() : string
abstract deprecated
since

11.1

deprecated

12.1

Response

string

get

Returns a property of the object or the default value if the property is not set.

get(string $property, mixed $default = null) : mixed
inherited
since

11.1

see \JObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if JError objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

getInstance

Returns a JPanel object.

getInstance(string $behavior = 'Tabs', array $params = array()) : object
static deprecated
deprecated

12.1

since

11.1

Arguments

$behavior

stringThe behavior to use.

$params

arrayAssociative array of values.

Response

object

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

11.1

see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

set

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$error

stringError message.

setProperties

Set the object properties based on a named array/hash.

setProperties(mixed $properties) : boolean
inherited
since

11.1

see \JObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

startPane

Creates a pane and creates the javascript object for it.

startPane(string $id) : string
abstract deprecated
since

11.1

deprecated

12.1

Arguments

$id

stringThe pane identifier.

Response

string

startPanel

Creates a panel with title text and starts that panel.

startPanel(string $text, string $id) : string
abstract deprecated
deprecated

12.1

since

11.1

Arguments

$text

stringThe panel name and/or title.

$id

stringThe panel identifer.

Response

string

toString

Converts the object to a string (the class name).

toString() : string
inherited deprecated
since

11.1

deprecated

12.1 Use magic method __toString()

see \JObject::__toString()

Response

string

Properties

useCookies

Type(s)

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array