gridColumn Class Reference

Defines characteristics for a column within a <class>ZEN.component.grid</class>. More...

Inheritance diagram for gridColumn:

Collaboration diagram for gridColumn:

Public Attributes
	columnName
	Logical name of column. More...
	format
	Format to apply to cells in this column. More...
	hidden
	If true, this column is not displayed. More...
	label
	Label displayed for column. More...
	logicalValue
	Optional. More...
	lookupSpec
	Optional. More...
	priority
	Priority of this column. More...
	readOnly
	If true, cells in this column are readOnly. More...
	style
	Style to apply to cells in this column. More...
	title
	Help text displayed when mouse hovers over this column. More...
	type
	Optional. More...
	value
	Default value to apply to (empty) cells in this column. More...
	valueList
	Optional. More...
	width
	Width of column. 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
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...
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 characteristics for a column within a <class>ZEN.component.grid</class>.

Member Data Documentation

columnName

columnName

Logical name of column.

 

format

format

Format to apply to cells in this column.

This is a DeepSee format string: e.g., "###.##" Note that column format overrides row format.  

hidden

hidden

If true, this column is not displayed.

 

label

label

Label displayed for column.

This overrides the value from a data controller.

 

logicalValue

logicalValue

Optional.

Default logical value used for this column. Used by DeepSee worksheets.  

lookupSpec

lookupSpec

Optional.

Information on how to lookup values for this column. Used by DeepSee worksheets.  

priority

priority

Priority of this column.

This lets you control the precedence of column-based attributes (style, format, value). By default (when the priority values are equal) column-based attributes have precedence over row-based attributes. If the column has a higher or equal-valued priority, then it takes precedence.  

readOnly

readOnly

If true, cells in this column are readOnly.

 

style

style

Style to apply to cells in this column.

This is a CSS style string: e.g., "color: red;" Note that column style overrides row style.  

title

title

Help text displayed when mouse hovers over this column.

Note that column title overrides row title.  

type

type

Optional.

Type of cells in this column. Used by DeepSee worksheets.  

value

value

Default value to apply to (empty) cells in this column.

This value is applied after the row value.  

valueList

valueList

Optional.

If the column type is "enum", this is a csv list of allowed values. Used by DeepSee worksheets.  

width

width

Width of column.