THyperLink
extends TTextDisplay
in package
File Link
Tags
Table of Contents
Properties
- $children : mixed
Methods
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Class Constructor
- __get() : mixed
- Returns a property's value
- __isset() : mixed
- Returns is a property's is set
- __set() : mixed
- Intercepts whenever someones assign a new property's value
- __toString() : mixed
- Converts the object into a string
- __unset() : mixed
- Intercepts whenever someones unset a property's value
- add() : mixed
- Add an child element
- addMany() : mixed
- Add many children
- after() : mixed
- Insert element after
- before() : mixed
- Insert element before
- clearChildren() : mixed
- Clear element children
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- del() : mixed
- Del an child element
- enableToggleVisibility() : mixed
- Enable toggle visible
- enableVoidElement() : mixed
- Turn element into a void element
- find() : mixed
- Find child element
- get() : mixed
- Get an child element
- getAfterElement() : mixed
- Return the after element
- getBeforeElement() : mixed
- Return the before element
- getChildren() : mixed
- get children
- getContents() : mixed
- Returns the element content as a string
- getIsWrapped() : mixed
- Return if the element is wrapped inside another one
- getName() : mixed
- Returns tag name
- getProperties() : mixed
- Return element properties
- getProperty() : mixed
- Return a property
- getSize() : mixed
- Returns the field size
- hide() : mixed
- hide object
- insert() : mixed
- Insert an child element
- open() : mixed
- BC only
- openTag() : mixed
- Opens the tag
- setIsWrapped() : mixed
- Define if the element is wrapped inside another one
- setLabel() : mixed
- Replace current label
- setName() : mixed
- Change the element name
- setProperties() : mixed
- Set element properties
- setProperty() : mixed
- Set tag property
- setSize() : mixed
- Define the Text's width
- setStyleProperty() : mixed
- Change some inline style property
- setTextAlign() : mixed
- Define the text align
- setTransformer() : mixed
- Define a callback function to be applyed over the column's data
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- show() : mixed
- Shows the tag
- tag() : mixed
- Create an element
Properties
$children
protected
mixed
$children
Methods
__clone()
Clone the object
public
__clone() : mixed
__construct()
Class Constructor
public
__construct(mixed $value, mixed $location[, mixed $color = null ][, mixed $size = null ][, mixed $decoration = null ][, mixed $icon = null ]) : mixed
Parameters
- $value : mixed
-
text content
- $location : mixed
-
link location
- $color : mixed = null
-
text color
- $size : mixed = null
-
text size
- $decoration : mixed = null
-
text decorations (b=bold, i=italic, u=underline)
- $icon : mixed = null
__get()
Returns a property's value
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__isset()
Returns is a property's is set
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__set()
Intercepts whenever someones assign a new property's value
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
__toString()
Converts the object into a string
public
__toString() : mixed
__unset()
Intercepts whenever someones unset a property's value
public
__unset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
add()
Add an child element
public
add(mixed $child) : mixed
Parameters
- $child : mixed
-
Any object that implements the show() method
addMany()
Add many children
public
addMany(mixed $children) : mixed
Parameters
- $children : mixed
-
Array of child
after()
Insert element after
public
after(mixed $element) : mixed
Parameters
- $element : mixed
before()
Insert element before
public
before(mixed $element) : mixed
Parameters
- $element : mixed
clearChildren()
Clear element children
public
clearChildren() : mixed
close()
BC only
public
close() : mixed
closeTag()
Closes the tag
public
closeTag() : mixed
del()
Del an child element
public
del(mixed $object) : mixed
Parameters
- $object : mixed
enableToggleVisibility()
Enable toggle visible
public
enableToggleVisibility([mixed $toggleVisibility = TRUE ]) : mixed
Parameters
- $toggleVisibility : mixed = TRUE
enableVoidElement()
Turn element into a void element
public
enableVoidElement() : mixed
find()
Find child element
public
find(mixed $element[, mixed $properties = null ]) : mixed
Parameters
- $element : mixed
-
tag name
- $properties : mixed = null
-
match properties
get()
Get an child element
public
get(mixed $position) : mixed
Parameters
- $position : mixed
-
Element position
getAfterElement()
Return the after element
public
getAfterElement() : mixed
getBeforeElement()
Return the before element
public
getBeforeElement() : mixed
getChildren()
get children
public
getChildren() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getIsWrapped()
Return if the element is wrapped inside another one
public
getIsWrapped() : mixed
getName()
Returns tag name
public
getName() : mixed
getProperties()
Return element properties
public
getProperties() : mixed
getProperty()
Return a property
public
getProperty(mixed $name) : mixed
Parameters
- $name : mixed
-
property name
getSize()
Returns the field size
public
getSize() : mixed
hide()
hide object
public
hide() : mixed
insert()
Insert an child element
public
insert(mixed $position, mixed $child) : mixed
Parameters
- $position : mixed
-
Element position
- $child : mixed
-
Any object that implements the show() method
open()
BC only
public
open() : mixed
openTag()
Opens the tag
public
openTag() : mixed
setIsWrapped()
Define if the element is wrapped inside another one
public
setIsWrapped(mixed $bool) : mixed
Parameters
- $bool : mixed
setLabel()
Replace current label
public
setLabel(mixed $label) : mixed
Parameters
- $label : mixed
setName()
Change the element name
public
setName(mixed $tagname) : mixed
Parameters
- $tagname : mixed
-
Element name
setProperties()
Set element properties
public
setProperties(mixed $properties) : mixed
Parameters
- $properties : mixed
setProperty()
Set tag property
public
setProperty(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
setSize()
Define the Text's width
public
setSize(mixed $width) : mixed
Parameters
- $width : mixed
-
Field's width in pixels
setStyleProperty()
Change some inline style property
public
setStyleProperty(mixed $property, mixed $value) : mixed
Parameters
- $property : mixed
-
Style property
- $value : mixed
-
Style value
setTextAlign()
Define the text align
public
setTextAlign(mixed $align) : mixed
Parameters
- $align : mixed
-
Text Align
setTransformer()
Define a callback function to be applyed over the column's data
public
setTransformer(mixed $callback) : mixed
Parameters
- $callback : mixed
-
A function name of a method of an object
setUseLineBreaks()
Set the use of linebreaks
public
setUseLineBreaks(mixed $linebreaks) : mixed
Parameters
- $linebreaks : mixed
-
boolean
setUseSingleQuotes()
Set the use of single quotes
public
setUseSingleQuotes(mixed $singlequotes) : mixed
Parameters
- $singlequotes : mixed
-
boolean
show()
Shows the tag
public
show() : mixed
tag()
Create an element
public
static tag(mixed $tagname, mixed $value[, mixed $attributes = NULL ]) : mixed
Parameters
- $tagname : mixed
-
Element name
- $value : mixed
-
Element value
- $attributes : mixed = NULL
-
Element attributes