Defines column information for a <class>ZEN.Component.tablePane</class>. More...

Inheritance diagram for column:

[legend]

Collaboration diagram for column:

[legend]

Public Member Functions
	getColName ()
	Defines column information for a <class>ZEN.Component.tablePane</class>. More...

Public Member Functions inherited from object
_.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
	OnDrawCell
	Optional. More...

	OnDrawFilter
	Optional. More...

	cellTitle
	Optional. More...

	colExpression
	If specified, this is an SQL expression used to get the value of this. More...

	colName
	If specified, name of data column this object is associated with. More...

	disableSort
	Optional. More...

	filterEnum
	Optional. More...

	filterEnumDisplay
	Optional. More...

	filterLabel
	Optional. More...

	filterOp
	Optional. More...

	filterQuery
	Optional. More...

	filterTitle
	Optional. More...

	filterType
	Optional. More...

	filterValue
	Optional. More...

	header
	Optional. More...

	hidden
	Optional. More...

	link
	Optional. More...

	linkCaption
	Optional. More...

	linkConfirm
	Optional. More...

	linkImage
	Optional. More...

	maxDate
	Optional. More...

	minDate
	Optional. More...

	onclick
	onclick event handler: More...

	seed
	Optional. More...

	style
	Optional. More...

	title
	Optional. More...

	width
	Optional. More...

Public Attributes inherited from object
	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...

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...

Static Public Attributes inherited from object
	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...

Detailed Description

Defines column information for a <class>ZEN.Component.tablePane</class>.

This class lets you specify details for how a column should be displayed within a tablePane. These details include:

Whether to hide a column (the <property>hidden</property> property)
Whether a column should display a link or action (the <property>link</property> property)
What header to use for a column (the <property>header</property> property)
Whether to display a search filter for a column along with details of the filter (the <property>filter</property> properties)
Additional styles for a column (the <property>style</property> property)

Member Function Documentation

◆ getColName()

getColName ( )

Defines column information for a <class>ZEN.Component.tablePane</class>.

This class lets you specify details for how a column should be displayed within a tablePane. These details include:

Whether to hide a column (the <property>hidden</property> property)
Whether a column should display a link or action (the <property>link</property> property)
What header to use for a column (the <property>header</property> property)
Whether to display a search filter for a column along with details of the filter (the <property>filter</property> properties)
Additional styles for a column (the <property>style</property> property)

Return the column name for this column.

Member Data Documentation

◆ OnDrawCell

OnDrawCell

Optional.

Name of Server-side callback method that provides HTML content for cells within this column.
If defined, this callback is invoked on the server when this component is drawn. It provides HTML content by using &html or by using the WRITE command.
This must be the name of a server-only method in the page class that contains this view component.

◆ OnDrawFilter

OnDrawFilter

Optional.

Name of server-side callback method that provides HTML content for the filter displayed for this column. This is used when the value of <property>filterType</property> is set to "custom".
If defined, this callback is invoked on the server when this component is drawn. It provides HTML content by using &html or by using the WRITE command.
This must be the name of a server-only method (with the correct signature) in the page class that contains this column object.

◆ cellTitle

cellTitle

Optional.

Tooltip help for data column. This is a localizable value.

◆ colExpression

colExpression

If specified, this is an SQL expression used to get the value of this.

column if the table is automatically constructing an SQL query. If a subquery is to be used as expression, it must be enclosed in braces.
For example: "FirstName||LastName"
"(select name from Sample.Person)"
If specified, colName must also be set. colExpression doesn't support column aliases, use colName instead. This value is encrypted and cannot be modified on the client.

◆ colName

colName

If specified, name of data column this object is associated with.

If not specified, then this column is displayed without a data value (typically used to display a link action in a row).
When used with a <class>ZEN.Component.tablePane</class> component, this can also take one of the following special values:

"$selector" - define a style for the special selector column in the table.
"$rownumber" - define a style for the row number column in the table.
"$checkbox" - define a style for the checkbox column in the table (when in multiSelect mode).

The name of a data column must be a valid name (and not an expression).

◆ disableSort

disableSort

Optional.

If true, do not allow sorting on this column.

◆ filterEnum

filterEnum

Optional.

If <property>filterType</property> is "enum", this property defines the set of enumerated logical values used by the filter as a comma-delimited list.

◆ filterEnumDisplay

filterEnumDisplay

Optional.

If <property>filterType</property> is "enum", this property defines the set of enumerated display values used by the filter as a comma-delimited list.
The logical values are defined by <property>filterEnum</property>.
This is a localized value.

◆ filterLabel

filterLabel

Optional.

If defined, this is a label to display for the filter control. If there is a multi-part filter control (such as a range), then this is assumed to contain a comma-delimited list of labels.

◆ filterOp

filterOp

Optional.

If this column has a filter, this is the name of the SQL operator that should be used in conjunction with the filter.
For UP[, <property>filterValue</property> will be converted to a case insensitive value.
For "IN", <property>filterValue</property> is treated as a csv-list of IN-clause values.
For "%CONTAINS", <property>filterValue</property> is treated as a csv-list of CONTAINS-clause values.
For "BETWEEN", <property>filterValue</property> is treated as a csv-list of 2 values used for the BETWEEN clause of the query.

◆ filterQuery

filterQuery

Optional.

If <property>filterType</property> is "query", this property defines the SQL statement used to provide the set of values for a drop-down list. If the query has more than 1 column, the first column is used as the logical value (this is what is used in a search) and the second column is used as a display value.

◆ filterTitle

filterTitle

Optional.

If this column has a filter, this is the tooltip text displayed for the filter control.
This is a localizable value.

◆ filterType

filterType

Optional.

If defined, specifies that this column should display a search filter box and what type of filter control to display.
If you do not provide a value for <property>colName</property> then the filter will not be created.
The possible filter types include:

"text" - display a text box.
"date" - display a date using a popup calendar control. If <property>filterOp</property> is "BETWEEN", then 2 controls are displayed.
"datetime" - same as "date" except that a complete timestamp (date and time) is used.
"enum" - display a set of enumerated values in a combobox. The possible choices are specified by <property>filterEnum</property> and <property>filterEnumDisplay</property>.
"query" - display a set of values in a combobox. The contents of the combobox are provided by executing the query specified by <property>filterQuery</property>.
"custom" - display a custom filter using the server-side callback method specified by <property>OnDrawFilter</property>.

◆ filterValue

filterValue

Optional.

Value of the column filter for this column.
Typically this acquires a value after user input, but you can set this property to define an initial value.

◆ header

header

Optional.

If defined, use this value for the column header.

◆ hidden

hidden

Optional.

If true, do not display this column.

◆ link

link

Optional.

If defined, render this column as a link using this URL. If you want to invoke a method, start the URL with "javascript:":
link="javascript:zenPage.myMethod();"
Optionally, set this to "#" (to make the column display as a link) and use the <property>onclick</property> event for this column.

◆ linkCaption

linkCaption

Optional.

If this column has an action (link or onclick) and does not contain data, then use this caption for the link. If linkCaption and linkImage is defined, linkCaption is used as alt text for the image.

◆ linkConfirm

linkConfirm

Optional.

If defined, and this column has a link, this is a confirmation message displayed before the link is executed.
If there is an <property>onclick</property> defined for this column, then this is ignored.
This is a localizable value.

◆ linkImage

linkImage

Optional.

If provided, link has to be defined.

If defined, render this column as a link using the image provided by this URL pointing to the URI defined by link.

◆ maxDate

maxDate

Optional.

If specified, this is the latest date allowed by the filter if filterType is dateTime. This is a date in the form "YYYY-MM-DD".

◆ minDate

minDate

Optional.

If specified, this is the earliest date allowed by the filter if filterType is dateTime. This is a date in the form "YYYY-MM-DD".

◆ onclick

onclick

onclick event handler:

This event is fired when the mouse is clicked within a cell in this column. If the column does not have data associated with it you will have to set the <property>linkCaption</property> property.
Note that this callback is called before the new row in the table is selected so you will not have the current selectedIndex for the table when this callback is fired. If you need that, use the tablePane's onselectrow callback.

◆ seed

seed

Optional.

This value is passed to the <method>OnDrawCell</method> method associated with this column.

◆ style

style

Optional.

Additional style to apply to cells (td element) in this column.
This is a CSS style string: e.g., "color: red;"

◆ title

title

Optional.

Tooltip help for column header. This is a localizable value.

◆ width

width

Optional.

If defined, use this value as the width of the column.

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getColName()

Member Data Documentation

◆ OnDrawCell

◆ OnDrawFilter

◆ cellTitle

◆ colExpression

◆ colName

◆ disableSort

◆ filterEnum

◆ filterEnumDisplay

◆ filterLabel

◆ filterOp

◆ filterQuery

◆ filterTitle

◆ filterType

◆ filterValue

◆ header

◆ hidden

◆ link

◆ linkCaption

◆ linkConfirm

◆ linkImage

◆ maxDate

◆ minDate

◆ onclick

◆ seed

◆ style

◆ title

◆ width