Base class for all ZEN components. More...

Inheritance diagram for object:

[legend]

Collaboration diagram for object:

[legend]

Public Member Functions
_.Library.Status	OnNew (_.Library.RawString initvalue)
	Constructor for Zen objects. More...

	findElement (subid)
	Client-side utility method that finds an HTML element with a. More...

	fireOnUpdateEvent ()
	This is called when an object is updated from the server. More...

_.Library.String	getProperty (property, key)
	Return the value of a named property (i.e. More...

	getSettings (settings)
	Client-side method that returns a list of this component's. More...

	getType ()
	Returns the component type of this object. More...

	invokeSuper (method, args)
	Invoke the superclass method method of the current. More...

	isOfType (type)
	Returns true if this object is of the given component type. More...

	makeId (subid)
	client-side utility method that constructs a component-specific id More...

	onCreate ()
	This client method, if present, is called when this component is. More...

	onDelete ()
	This client method, if present, is called when this component is. More...

	onSerialize ()
	This client event, if present, is fired before a component. More...

	onloadHandler ()
	This client event, if present, is fired when the page is loaded.

	onunloadHandler ()
	This client event, if present, is fired when the page is unloaded. More...

	onupdateHandler ()
	This client method, if present, is fired when the object is updated from the server.

	render ()
	This causes a component that draws its contents dynamically. More...

	renderContents ()
	This method, if present, is called when this component. More...

	renderSVG (document, parent)
	This method is only needed for SVG components. More...

	setProperty (property, value, value2)
	Set the value of a named property (i.e., a setting). More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Public Attributes
	aux
	@qualifier final This is an auxiliary property that is provided More...

	composite
	@qualifier final For components that are created as part of a composite component, More...

	id
	@qualifier final This is a unique identifier that is used to distinguish this object More...

	index
	@qualifier final System-assigned index number used internally to identify this component. More...

	name
	@qualifier final Name of this object. More...

	onupdate
	onupdate event handler: More...

	parent
	@qualifier final Link to the component that contains this object More...

	tuple
	@qualifier final Special property indicating which tuple of a More...

	visible
	This property indicates whether a component is visible and thus layed out. More...

	window
	@qualifier final This is a client-only property that refers to the JavaScript More...

Static Public Attributes
	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.

	INCLUDEFILES = None
	CSV list of additional include files (either .js or .css) that. More...

	MODULE = None
	If set, this indicates that this system component should be. More...

	NAMESPACE = None
	This is the XML namespace used for library components.

	POSTCOMPILEACTIONS = None
	This is a comma-delimited list of which post-compile actions this component. More...

	USECOMMONDIRECTORY = None
	If true, then the include files generated for this component, are placed in the. More...

	XMLFORMAT = None
	If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	By setting this to 0, we disallow use of invalid attribute names in Zen XML documents.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Private Member Functions
_.Library.String	Attr (_.Library.String pName, _.Library.String pValue)
	Utility method used when writing out HTML attribute values. More...

	DrawHTML ()
	Static HTML display method: draw the BODY of this component. More...

_.Library.String	Eval (_.Library.String pExpr, _.Library.String pEscape)
	Utility method; takes a property value containing a #()# expression. More...

	ForceClientRender ()
	Call this method to force the client to call this object's. More...

_.Library.String	GetEventHandlers (pIgnore)
	This helper method returns a string of HTML/XML attributes that. More...

_.Library.String	MakeId (_.Library.String pSubID)
	Server-side utility method that constructs a component-specific id. More...

_.Library.Status	NormalizeObject ()
	Normalizes all of an object's property values by invoking the data type Normalize methods. More...

_.Library.Status	OnAddToPageAfter ()
	If implemented, this callback method is called at page render-time. More...

_.Library.Status	OnAddToPageBefore ()
	If implemented, this callback method is called at page render-time. More...

	OnDrawObjectProperties ()
	If defined, this callback is invoked by the <method>DrawObjectProperties</method> More...

_.Library.Status	OnObjectSynch ()
	If defined, this callback is invoked by the <method>ObjectSynch</method> More...

_.Library.Status	OnZENDeserialize ()
	If defined, this callback is invoked by the <method>ZENDeserialize</method> More...

_.Library.Status	RemoveFromSaveSet ()

_.Library.String	Self ()
	Return a JS expression that will evaluate to this component. More...

Static Private Member Functions
_.Library.Status	DrawJSStrings (_.Library.String pVisited)
	Render list of localized javascript strings for this object.

_.Library.Integer	GetXMLName (_.Library.String pNamespace, _.Library.String pName)
	Return the XML namespace and element name for this component. More...

	QuoteValue (_.Library.String pValue)
	Take a value string and return a quoted string.

	QuoteValueL10N (_.Library.String pValue)
	Take a value string and return a quoted string wrapped within a. More...

Additional Inherited Members
Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Detailed Description

Base class for all ZEN components.

An object, by itself, can be used to create objects that can be shared between a server and a browser client environment. All visual component, are derived from <class>component</class>, which is a subclass of <class>object</class>.

Member Function Documentation

◆ Attr()

_.Library.String Attr	(	_.Library.String	pName,
		_.Library.String	pValue
	)

private

Utility method used when writing out HTML attribute values.

Given an attribute name and value, this returns the string attr=""value"" with value HTML escaped. If value is "", then "" is returned.

◆ DrawHTML()

DrawHTML ( )

private

Static HTML display method: draw the BODY of this component.

as HTML.
Subclasses implement this in order to render the static HTML contents of a component.

Reimplemented in svgFrame, svgComponent, selector, assistedText, svgImageProvider, scribbleArea, schedulePane, documentView, colorWheel, titlePane, titleBox, textarea, text, tablePane, tableNavigatorBar, tableNavigator, tabGroup, tabFrame, submit, spacer, snapGrid, simpleTablePane, select, repeatingGroup, radioSet, radioButton, password, objectBrowser, navigator, multiSelectSet, menuSeparator, menuItem, menu, lookoutMenu, loginForm, locatorBar, link, label, image, iframe, html, hidden, helpBox, hbutton, group, form, fileUpload, fieldSet, expando, dynaView, dynaTree, dragGroup, desktop, dateText, dateSelect, dataCombo, csMenuSeparator, csMenuItem, csMenuBarItem, csMenuBar, csComboBoxItem, csComboBox, corkboard, contextMenu, colorPicker, colorPane, checkbox, canvas, calendar, buttonView, buttonBarItem, buttonBar, button, activeVGroup, activeHGroup, activeGroup, abstractListBox, abstractDragGroupMgr, abstractComboBox, toggleIcon, textStyleBar, textJustifyBar, textInfoWizard, strokeWidthBar, strokeStyleBar, spinner, schemaEditPanel, reportPreviewer, reportModelServer, popGroup, pickBox, pageSetupControl, pageNumberWizard, imageURLWizard, hSlider, dataPickPool, colorPip, colorPalette, codeEditor, chartInfoWizard, captionEditor, busyPanel, barcodeWizard, bannerWorkspace, argTableEditor, abstractIconBar, widget, abstractControlPanel, abstractPortlet, styleEdit, searchBox, pivotTable, pivotController, deepseeCSVProvider, coverView, chartLegend, UserRoles, SQLTables, SQLPrivileges, RoleMemberTab, and ApplicationRoles.

◆ Eval()

_.Library.String Eval	(	_.Library.String	pExpr,
		_.Library.String	pEscape
	)

private

Utility method; takes a property value containing a #()# expression.

and evaluates it. This is called by the $$$ZENVAL macro.

◆ ForceClientRender()

ForceClientRender ( )

private

Call this method to force the client to call this object's.

<method>renderContents</method> if it has one.

◆ GetEventHandlers()

_.Library.String GetEventHandlers ( pIgnore )

private

This helper method returns a string of HTML/XML attributes that.

will define all event handler properties defined for a control.
pIgnore is an array of names of events that should be ignored.
If the properties W3CEVENT parameter is set to 0, then it will be ignored.

◆ GetXMLName()

_.Library.Integer GetXMLName	(	_.Library.String	pNamespace,
		_.Library.String	pName
	)

staticprivate

Return the XML namespace and element name for this component.

These are return via the parameters pNamespace and pName respectively.

◆ MakeId()

_.Library.String MakeId ( _.Library.String pSubID )

private

Server-side utility method that constructs a component-specific id.

value for use in assigning ids to HTML/XML elements. If we are part of a repeating group, the tuple number is included in the id as well.

◆ NormalizeObject()

_.Library.Status NormalizeObject ( )

private

Normalizes all of an object's property values by invoking the data type Normalize methods.

Many data types may allow many different representations of the same value. 
Normalization converts a value to its cannonical, or <em>normalized</em>, form.

Reimplemented from RegisteredObject.

◆ OnAddToPageAfter()

_.Library.Status OnAddToPageAfter ( )

private

If implemented, this callback method is called at page render-time.

after this component has been added to a page and after any of its children have been created but before the DrawHTML methods are called.

Reimplemented in svgFrame, tablePane, loginForm, form, and dynaGrid.

◆ OnAddToPageBefore()

_.Library.Status OnAddToPageBefore ( )

private

If implemented, this callback method is called at page render-time.

when this component is added to a page but before any of its children have been created.

Reimplemented in pane, widget, and controlPanel.

◆ OnDrawObjectProperties()

OnDrawObjectProperties ( )

private

If defined, this callback is invoked by the <method>DrawObjectProperties</method>

method.

Reimplemented in dataSet, and dataBag.

◆ OnNew()

_.Library.Status OnNew ( _.Library.RawString initvalue )

Constructor for Zen objects.

If subclasses override OnNew, they should make sure to invoke this using #super.

Reimplemented in dynaGrid, composite, jsonMDXProvider, dataSet, abstractController, and pivotTable.

◆ OnObjectSynch()

_.Library.Status OnObjectSynch ( )

private

If defined, this callback is invoked by the <method>ObjectSynch</method>

method.

Reimplemented in dataSet, and dataBag.

◆ OnZENDeserialize()

_.Library.Status OnZENDeserialize ( )

private

If defined, this callback is invoked by the <method>ZENDeserialize</method>

method.

Reimplemented in tablePane, dataSet, and dataBag.

◆ QuoteValueL10N()

QuoteValueL10N ( _.Library.String pValue )

staticprivate

Take a value string and return a quoted string wrapped within a.

$$$Text macro.
If value starts and ends with #( )#, then return an expression

◆ RemoveFromSaveSet()

_.Library.Status RemoveFromSaveSet ( )

private

This method removes the current object from the SaveSet. If this object is also in the save queue

it is removed from there as well.

Reimplemented from RegisteredObject.

◆ Self()

_.Library.String Self ( )

private

Return a JS expression that will evaluate to this component.

This is used when rendering HTML for a component and that HTML needs to refer back to this component for a JS expression (such as an event handler):
onclick="#(..%Self())#.someMethod();"

◆ findElement()

findElement ( subid )

Client-side utility method that finds an HTML element with a.

component-specific id.

◆ fireOnUpdateEvent()

fireOnUpdateEvent ( )

This is called when an object is updated from the server.

It will invoke the class-defined and user-defined onupdate event if defined.

◆ getProperty()

_.Library.String getProperty	(	property,
		key
	)

Return the value of a named property (i.e.

a setting).

Returns null if this is not a property of this object.
key is an optional argument used for properties (such as collections) that may need a key to find a specific value.

Reimplemented in scribbleArea, radioButton, lookup, label, control, and checkbox.

◆ getSettings()

getSettings ( settings )

Client-side method that returns a list of this component's.

run-time settable properties. These are the properties that the page designer Inspector allows a user to edit.
This list is returned by inserting the property names in the associative array (object) settings. Note: this method is automatically generated by DrawClassDefinition.

◆ getType()

getType ( )

Returns the component type of this object.

(e.g. "form", or "control").

◆ invokeSuper()

invokeSuper	(	method,
		args
	)

Invoke the superclass method method of the current.

object with arguments args.

◆ isOfType()

isOfType ( type )

Returns true if this object is of the given component type.

or is subclassed from the given component type. (e.g. "form", or "control")

◆ makeId()

makeId ( subid )

client-side utility method that constructs a component-specific id

value for use in assigning ids to HTML elements.
This is simply a client-side version of <method>MakeId</method>.

◆ onCreate()

onCreate ( )

This client method, if present, is called when this component is.

instantiated. This allows for any additional client-side initialization for this object.
Note that this must be a client-side method.

Reimplemented in ZENPageEditor, assistedText, objectInspector, objectBrowser, dynaView, dynaGrid, dataGrid, and abstractListBox.

◆ onDelete()

onDelete ( )

This client method, if present, is called when this component is.

removed from the page. This allows for any additional client-side clean up for this object.
Note that this must be a client-side method.

Reimplemented in timer, modalGroup, abstractComboBox, and abstractController.

◆ onSerialize()

onSerialize ( )

This client event, if present, is fired before a component.

is serialized. This gives the component a chance to make sure that its client-side variables are up-to-date.

Reimplemented in radioButton, label, control, and checkbox.

◆ onunloadHandler()

onunloadHandler ( )

This client event, if present, is fired when the page is unloaded.

If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).

Reimplemented in standardPage, standardPage, ClassifierBuilder, DashboardViewer, standardPage, Analyzer, pivotTable, RuntimeStats, ZenReportRenderServerAction, ZenReportPrintServerAction, ZenReportExcelServerAction, ReportsRenderServerAction, ReportsPrintServerAction, ReportsExcelServerAction, Utils, ObjectSettings, ServerOutput, and Manager.

◆ render()

render ( )

This causes a component that draws its contents dynamically.

to (re)create its contents.
This is a wrapper for the <method>renderContents<method> method (if present). Applications should call <method>render<method> to display dynamic components, but implement <method>renderContents<method> to implement dynamic components.

◆ renderContents()

renderContents ( )

This method, if present, is called when this component.

is placed on a client page.
This is used by components that render themselves using client-side, dynamic content (i.e., instead of using the <method>DrawHTML</method> method).

Reimplemented in timeRangeControl, timeLine, tabBar, svgComponent, sprite, rect, radialNavigator, pieChart, ownerDraw, meter, compassButtons, chart, finderPane, documentView, toolbar, tableNavigatorBar, tableNavigator, objectBrowser, navigator, lookup, dynaGrid, dragGroup, dataGrid, colorPane, canvas, calendar, accordionMenu, popGroup, scoreCard, styleEdit, pivotController, mapView, coverView, chartLegend, and tableNavBar.

◆ renderSVG()

renderSVG	(	document,
		parent
	)

This method is only needed for SVG components.

It is defined here so that we can detect if HTML components are used within an SVG context and throw an error.

Reimplemented in svgComponent.

◆ setProperty()

setProperty	(	property,
		value,
		value2
	)

Set the value of a named property (i.e., a setting).

Subclasses override this for cases where setting a property requires some additional side effect to happen.
The optional value2 argument is used in cases, such as collections, where a key and a value are needed. In this case value is used as a key and value2 is the value.
Return true if the property was explicitly handled and false for the default behavior (setting the property directly).

Reimplemented in chart, xyClusterChart, xyChart, treeMapChart, trafficLight, timeRangeControl, timeLine, textMeter, tabBar, swirlChart, svgGroup, svgFrame, svgComponent, svgCanvas, sprite, speedometer, smiley, slider, rect, radialNavigator, port, pieChart, percentbarChart, ownerDraw, meter, lineChart, lightBar, indicatorLamp, hilowChart, fuelGauge, diffChart, connector, compassButtons, comboChart, bullseyeChart, bubbleChart, barChart, selector, assistedText, scribbleArea, schedulePane, finderPane, documentView, colorWheel, toolbar, timer, textarea, text, tablePane, tableNavigatorBar, tableNavigator, tabGroup, tabFrame, spacer, snapGrid, simpleTablePane, select, repeatingGroup, radioSet, radioButton, navigator, multiSelectSet, lookup, lookoutMenu, loginForm, listControl, link, label, image, iframe, html, hbutton, group, form, fileUpload, fieldSet, expando, dynaView, dynaTree, dynaGrid, dynaForm, dragGroup, desktop, dateText, dateSelect, dataListBox, dataGrid, dataCombo, csMenuSeparator, csMenuItem, csMenuBarItem, csMenuBar, csComboBoxItem, csComboBox, control, contextMenu, component, combobox, colorPicker, colorPane, checkbox, canvas, calendar, buttonBarItem, buttonBar, button, activeVGroup, activeHGroup, activeGroup, abstractListBox, abstractGroup, abstractDragGroupMgr, abstractComboBox, dataController, dataBag, axis, abstractController, standardPage, DashboardViewer, toggleIcon, textStyleBar, textJustifyBar, strokeWidthBar, strokeStyleBar, spinner, popGroup, pickBox, hSlider, dataPickPool, colorPip, colorPalette, codeEditor, captionEditor, busyPanel, abstractIconBar, widget, pivot, scoreCard, styleEdit, pivotTable, pivotController, mapView, coverView, and chartLegend.

Member Data Documentation

◆ INCLUDEFILES

INCLUDEFILES = None

static

CSV list of additional include files (either .js or .css) that.

should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.

◆ MODULE

MODULE = None

static

If set, this indicates that this system component should be.

placed in the given "module". A module is a grouping of components within the same class package that share common include (js or css) files.

◆ POSTCOMPILEACTIONS

POSTCOMPILEACTIONS = None

static

This is a comma-delimited list of which post-compile actions this component.

is registered for. If this value is defined, then certain actions are carried out after this class is compiled.
The available choices are:

"schema" - update the schema used by Studio Assist when editing page definitions.
"HTML" - Regenerate any JS or CSS files associated with this class.
"SVG" - Regenerate any JS or SVG CSS files associated with this class.

◆ USECOMMONDIRECTORY

USECOMMONDIRECTORY = None

static

If true, then the include files generated for this component, are placed in the.

common /csp/broker directory and not the local /csp/*namespace* directory.
This is intended for use with packages that are mapped so as to be visible to every namespace.
All Zen classes within the same package must have the same value for this parameter. It is the developer's responsibility to ensure this.

◆ XMLFORMAT

XMLFORMAT = None

static

If XMLFORMAT="Literal", then only support for literal format import and export is generated.

◆ aux

aux

@qualifier final This is an auxiliary property that is provided

as a place to hold additional user-defined values for components. This property is not used by the ZEN framework.

◆ composite

composite

@qualifier final For components that are created as part of a composite component,

this is a link to the composite that contains this object. Applications should not set this property.

◆ id

id

@qualifier final This is a unique identifier that is used to distinguish this object

from other objects within the same Zen page.
Every object within a Zen page must have a unique id value. You can find an object with a given id value using the page object's <method>getComponentById</method> method.

◆ index

index

@qualifier final System-assigned index number used internally to identify this component.

Applications can use but should not set this property.

◆ name

name

@qualifier final Name of this object.

This is primarily used to specify the name used for identifying a control within a form. It is also used to identify values that are submitted by controls on a form.
It is defined here for convenience.

◆ onupdate

onupdate

onupdate event handler:

This event is fired after the properties of the object have been updated from the server.

◆ parent

parent

@qualifier final Link to the component that contains this object

or somehow caused this component to be placed on the page.
For visual components, this is typically set to the group that contains the component.
For auxiliary components, this is set to the object that referred to this component in the page definition.
Applications should not set this property.

◆ tuple

tuple

@qualifier final Special property indicating which tuple of a

repeating group is rendering this component. This property only has meaning when a component is part of a repeating group. Applications should not set this property.

◆ visible

visible

This property indicates whether a component is visible and thus layed out.

This is a class-wide property set by the object constructor.
Applications should not set this property; Sub-classes can set this via the <parameter>DEFAULTVISIBLE</parameter>.

◆ window

window

@qualifier final This is a client-only property that refers to the JavaScript

Window object on which this object was created.
Applications should not set this property.

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Attr()

◆ DrawHTML()

◆ Eval()

◆ ForceClientRender()

◆ GetEventHandlers()

◆ GetXMLName()

◆ MakeId()

◆ NormalizeObject()

◆ OnAddToPageAfter()

◆ OnAddToPageBefore()

◆ OnDrawObjectProperties()

◆ OnNew()

◆ OnObjectSynch()

◆ OnZENDeserialize()

◆ QuoteValueL10N()

◆ RemoveFromSaveSet()

◆ Self()

◆ findElement()

◆ fireOnUpdateEvent()

◆ getProperty()

◆ getSettings()

◆ getType()

◆ invokeSuper()

◆ isOfType()

◆ makeId()

◆ onCreate()

◆ onDelete()

◆ onSerialize()

◆ onunloadHandler()

◆ render()

◆ renderContents()

◆ renderSVG()

◆ setProperty()

Member Data Documentation

◆ INCLUDEFILES

◆ MODULE

◆ POSTCOMPILEACTIONS

◆ USECOMMONDIRECTORY

◆ XMLFORMAT

◆ aux

◆ composite

◆ id

◆ index

◆ name

◆ onupdate

◆ parent

◆ tuple

◆ visible

◆ window