Methods
NoteLink: Creates a new note link item.
NoteLink(\$sItemType $sItemType, \$sItemId $sItemID) : \none
This link is used to show the popup from any position within the system.
The link contains the note image.
Parameters
$sItemType
\$sItemTypestring Item type (usually the class name)
$sItemID
\$sItemIdmixed Item ID (usually the primary key)
Returns
\none
Constructor Function
Initializes the SGML open/close tags
__construct() : void
Inherited
| inherited_from |
\cHTML::__construct() |
| inherited_from |
\cHTMLLink::__construct() |
_setContent: Sets the content of the object
_setContent(\$content $content)
Inherited
| inherited_from |
\cHTML::_setContent() |
| inherited_from |
\cHTMLLink::_setContent() |
Parameters
$content
\$contentstring/object String with the content or an object to render.
addRequiredScript()
addRequiredScript($script)
Inherited
| inherited_from |
\cHTML::addRequiredScript() |
| inherited_from |
\cHTMLLink::addRequiredScript() |
Parameters
$script
advances to the next ID available in the system.
advanceID()
Inherited
This function is useful if you need to use HTML elements
in a loop, but don't want to re-create new objects each time.
| inherited_from |
\cHTML::advanceID() |
| inherited_from |
\cHTMLLink::advanceID() |
attachEventDefinition: Attaches the code for an event
attachEventDefinition(\$sName $sName, \$sEvent $sEvent, \$sCode $sCode)
Inherited
Example to attach an onClick handler:
setEventDefinition("foo", "onClick", "alert('foo');");
| inherited_from |
\cHTML::attachEventDefinition() |
| inherited_from |
\cHTMLLink::attachEventDefinition() |
Parameters
$sName
\$sNamestring defines the name of the event
$sEvent
\$sEventstring defines the event (e.g. onClick)
$sCode
\$sCodestring defines the code
attachStyleDefinition: Attaches a style definition.
attachStyleDefinition(\$sName $sName, \$sDefinition $sDefinition) : string
Inherited
This function is not restricted to a single style, e.g.
you can set multiple style definitions as-is to the handler.
$example->attachStyle("myIdentifier",
"border: 1px solid black; white-space: nowrap");
$example->attachStyle("myIdentifier2",
"padding: 0px");
Results in:
style="border: 1px solid black; white-space: nowrap; padding: 0px;"
| inherited_from |
\cHTML::attachStyleDefinition() |
| inherited_from |
\cHTMLLink::attachStyleDefinition() |
Parameters
$sName
\$sNamestring Name for a style definition
$sDefinition
\$sDefinitionstring Definition for the given entity
Returns
stringfilled SGML closing skeleton
old Constructor
cHTML()
Inherited
| inherited_from |
\cHTML::cHTML() |
| inherited_from |
\cHTMLLink::cHTML() |
Constructor. Creates an HTML link.
cHTMLLink(\$href $href)
Inherited
| inherited_from |
\cHTMLLink::cHTMLLink() |
Parameters
$href
\$hrefString with the location to link to
disableAutomaticParameterAppend()
disableAutomaticParameterAppend()
Inherited
| inherited_from |
\cHTMLLink::disableAutomaticParameterAppend() |
disableHistory: Disables the display of all note items
disableHistory() : \none
disableHistoryDelete: Disables the delete function in the history view
disableHistoryDelete() : \none
enableAutomaticParameterAppend()
enableAutomaticParameterAppend()
Inherited
| inherited_from |
\cHTMLLink::enableAutomaticParameterAppend() |
enableHistory: Enables the display of all note items
enableHistory() : \none
enableHistoryDelete: Enables the delete function in the history view
enableHistoryDelete() : \none
fillCloseSkeleton: Fills the close skeleton
fillCloseSkeleton() : string
Inherited
| inherited_from |
\cHTML::fillCloseSkeleton() |
| inherited_from |
\cHTMLLink::fillCloseSkeleton() |
Returns
stringfilled SGML closer skeleton
fillSkeleton: Fills the open SGML tag skeleton
fillSkeleton(\$attributes $attributes) : string
Inherited
fillSkeleton fills the SGML opener tag with the
specified attributes. Attributes need to be passed
in the stringyfied variant.
| inherited_from |
\cHTML::fillSkeleton() |
| inherited_from |
\cHTMLLink::fillSkeleton() |
Parameters
$attributes
\$attributesstring Attributes to set
Returns
stringfilled SGML opener skeleton
getHref()
getHref()
Inherited
| inherited_from |
\cHTMLLink::getHref() |
getID: returns the current ID
getID() : string
Inherited
| inherited_from |
\cHTML::getID() |
| inherited_from |
\cHTMLLink::getID() |
Returns
stringcurrent ID
render: Renders the resulting link
render($return) : \none
Parameters
$return
Returns
\none
setAlt: sets the alt and title attributes
setAlt(\$alt $alt)
Inherited
Sets the "alt" and "title" tags. Usually, "alt" is used
for accessibility and "title" for mouse overs.
To set the text for all browsers for mouse over, set "alt"
and "title". IE behaves incorrectly and shows "alt" on
mouse over. Mozilla browsers only show "title" as mouse over.
| inherited_from |
\cHTML::setAlt() |
| inherited_from |
\cHTMLLink::setAlt() |
Parameters
$alt
\$altstring Text to set as the "alt" attribute
setAnchor: Sets an anchor
setAnchor(\$content $anchor)
Inherited
Only works for the link types Link and cLink.
| inherited_from |
\cHTMLLink::setAnchor() |
Parameters
$anchor
\$contentstring Anchor name
setAttribte: Sets a specific attribute
setAttribute(\$sAttributeName $sAttributeName, \$sValue $sValue)
Inherited
| inherited_from |
\cHTML::setAttribute() |
| inherited_from |
\cHTMLLink::setAttribute() |
Parameters
$sAttributeName
\$sAttributeNamestring Name of the attribute
$sValue
\$sValuestring Value of the attribute
setLink: Sets a Contenido link (area, frame, action)
setCLink(\$targetarea $targetarea, \$targetframe $targetframe, \$targetaction $targetaction)
Inherited
| inherited_from |
\cHTMLLink::setCLink() |
Parameters
$targetarea
\$targetareastring Target backend area
$targetframe
\$targetframestring Target frame (1-4)
$targetaction
\$targetactionstring Target action
sets the CSS class
setClass(\$class $class)
Inherited
| inherited_from |
\cHTML::setClass() |
| inherited_from |
\cHTMLLink::setClass() |
Parameters
$class
\$classstring Text to set as the "alt" attribute
setContent: Sets the link's content
setContent(\$content $content)
Inherited
| inherited_from |
\cHTMLLink::setContent() |
Parameters
$content
\$contentstring/object String with the content or an object to render.
setContentlessTag()
setContentlessTag(\type $contentlessTag)
Inherited
| inherited_from |
\cHTML::setContentlessTag() |
| inherited_from |
\cHTMLLink::setContentlessTag() |
Parameters
$contentlessTag
\type
setCustom: Sets a custom attribute to be appended to the link
setCustom(\$key $key, \$value $value)
Inherited
| inherited_from |
\cHTMLLink::setCustom() |
Parameters
$key
\$keystring Parameter name
$value
\$valuestring Parameter value
adds an "onXXX" javascript event handler
setEvent(\$event $event, \$action $action)
Inherited
example:
$item->setEvent("change","document.forms[0].submit");
| inherited_from |
\cHTML::setEvent() |
| inherited_from |
\cHTMLLink::setEvent() |
Parameters
$event
\$eventstring Type of the event
$action
\$actionstring Function or action to call (JavaScript Code)
sets the ID class
setID(\$class $id)
Inherited
| inherited_from |
\cHTML::setID() |
| inherited_from |
\cHTMLLink::setID() |
Parameters
$id
\$classstring Text to set as the "id"
setLink: Sets the link to a specific location
setLink(\$href $href)
Inherited
| inherited_from |
\cHTMLLink::setLink() |
Parameters
$href
\$hrefString with the location to link to
setMultiLink: Sets a multilink
setMultiLink(\$righttoparea $righttoparea, \$righttopaction $righttopaction, \$rightbottomarea $rightbottomarea, \$rightbottomaction $rightbottomaction)
Inherited
| inherited_from |
\cHTMLLink::setMultiLink() |
Parameters
$righttoparea
\$righttopareastring Area (right top)
$righttopaction
\$righttopactionstring Action (right top)
$rightbottomarea
\$rightbottomareastring Area (right bottom)
$rightbottomaction
\$rightbottomactionstring Action (right bottom)
sets the CSS style
setStyle(\$class $style)
Inherited
| inherited_from |
\cHTML::setStyle() |
| inherited_from |
\cHTMLLink::setStyle() |
Parameters
$style
\$classstring Text to set as the "alt" attribute
addStyleDefinition
setStyleDefinition(\$entity $entity, \$definition $definition) : string
Inherited
| inherited_from |
\cHTML::setStyleDefinition() |
| inherited_from |
\cHTMLLink::setStyleDefinition() |
Parameters
$entity
\$entitystring Entity to define
$definition
\$definitionstring Definition for the given entity
Returns
stringfilled SGML closing skeleton
setTargetFrame: Sets the target frame
setTargetFrame(\$target $target)
Inherited
| inherited_from |
\cHTMLLink::setTargetFrame() |
Parameters
$target
\$targetstring Target frame identifier
Renders the link
toHTML() : string
Inherited
| inherited_from |
\cHTMLLink::toHTML() |
Returns
stringRendered HTML
removes an event handler
unsetEvent(\$event $event)
Inherited
example:
$item->unsetEvent("change");
| inherited_from |
\cHTML::unsetEvent() |
| inherited_from |
\cHTMLLink::unsetEvent() |
Parameters
$event
\$eventstring Type of the event
Properties
Defines which JS events contain which scripts
$_aEventDefinitions
Inherited
| inherited_from |
\cHTML::$$_aEventDefinitions |
| inherited_from |
\cHTMLLink::$$_aEventDefinitions |
Style definitions
$_aStyleDefinitions
Inherited
| inherited_from |
\cHTML::$$_aStyleDefinitions |
| inherited_from |
\cHTMLLink::$$_aStyleDefinitions |
$_anchor
$_anchor
Inherited
| inherited_from |
\cHTMLLink::$$_anchor |
The content itself
$_content
Inherited
| inherited_from |
\cHTMLLink::$$_content |
Defines if the current tag is a contentless tag
$_contentlessTag : boolean
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_contentlessTag |
| inherited_from |
\cHTMLLink::$$_contentlessTag |
$_custom
$_custom
Inherited
| inherited_from |
\cHTMLLink::$$_custom |
$_link
$_link
Inherited
| inherited_from |
\cHTMLLink::$$_link |
Defines all scripts which are required by the current element
$_requiredScripts : array
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_requiredScripts |
| inherited_from |
\cHTMLLink::$$_requiredScripts |
Storage of the close SGML tag
$_skeleton_close : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_skeleton_close |
| inherited_from |
\cHTMLLink::$$_skeleton_close |
Storage of the open SGML tag template
$_skeleton_open : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_skeleton_open |
| inherited_from |
\cHTMLLink::$$_skeleton_open |
Storage of a single SGML tag template
$_skeleton_single : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_skeleton_single |
| inherited_from |
\cHTMLLink::$$_skeleton_single |
Defines the style definitions
$_styledefs : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_styledefs |
| inherited_from |
\cHTMLLink::$$_styledefs |
Defines which tag to use
$_tag : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_tag |
| inherited_from |
\cHTMLLink::$$_tag |
If true, history items can be deleted
$_bDeleteHistoryItems : boolean
If true, shows the note history
$_bShowHistory : boolean
Object ID
$_sItemID : string
Object type
$_sItemType : string