timeLine Class Reference

SVG TimeLine component. More...

Inheritance diagram for timeLine:

Collaboration diagram for timeLine:

Public Member Functions
	computeAge (birthDate, currDate)
	Compute the age between currDate and birthDate, return it as an object.
	dragThumb (evt)
	Drag handler for vertical scrollbar thumb.
	getCellInfo (cell, majorUnits, minorUnits, index)
	Return information about a cell within the grid line.
	getModel ()
	Get the model used to drive the user portion of the time line.
	itemClick (evt, newId)
	Click on item.
	renderContents ()
	Render the inner SVG contents of this component.
	renderData (dataGroup, marginTop)
	Render the actual time line data.
	renderOneItem (group, item, length, size)
	Render one item on the timeline. More...
	renderTimeCells ()
	Render the time cells on the top/bottom.
	selectItem (newId)
	Select an item.
	setProperty (property, value, value2)
	Set the value of a named property.
	setTimeRange (startTime, endTime, reset, which)
	Set the timeline start and end dates and update. More...
	sortModel (model, range)
	Take the user-supplied data model and sort it by time. More...
Public Member Functions inherited from svgComponent
	beginWaitState ()
	Begin a wait state for this component. More...
	calculateViewBox ()
	Calculate the value of the viewBox attribute of this. More...
	clickHandler (evt)
	Default mouse click handler.
	endWaitState ()
	End the current wait state for this component.
	findSVGElement (subid)
	Client-side utility method that finds an SVG element with a. More...
	getFrame ()
	Return the svgFrame object this component belongs to.
	getSizeAbsolute ()
	Return an object containing (as x,y,width, and height properties) More...
	refreshContents ()
	This is not supported for SVG components.
	renderSVG (document, parent)
	Render the outer SVG enclosing group for this component. More...
	setOverlayMode (mode)
	Display an overlay for this component to trap mouse events. More...
	setPosition (x, y)
	Set the x,y position of this component. More...
	setPositionHandler ()
	Notification that this component has been moved. More...
	setSize (w, h)
	Set the size (width and height) of this component. More...
	setSizeHandler ()
	Notification that this component has been resized. More...
	setTextNode (id, str)
	Utility method: More...
	sizingMouseDownHandler (evt, which)
	Internal: sizing handle mouse down handler.
	unrender ()
	Remove the inner SVG for this component.
	wrapMethod (methodName)
	Utility method: 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...
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
	birthDate
	"Birth date" (as YYYY-MM-DD HH:MM:SS). More...
	dateFormat
	Optional. More...
	endTime
	Latest displayed time (as YYYY-MM-DD HH:MM:SS). More...
	marginLeft
	Left margin (in pixels). More...
	marginRight
	Right margin (in pixels). More...
	ongetdata
	ongetdata event handler: More...
	onrenderitem
	onrenderitem event handler: More...
	onselect
	onselect event handler: More...
	selectedId
	Id of selected item. More...
	spanHeight
	Height (in pixels) of a time span box on the time line. More...
	startTime
	Earliest displayed time (as YYYY-MM-DD HH:MM:SS). More...
	title
	Chart title. More...
Public Attributes inherited from svgComponent
	boundless
	If true, this component is boundless. More...
	document
	Client-side property that points to SVG document this component is rendered on. More...
	height
	Width of this component. More...
	hidden
	If true, this component is hidden. More...
	onclick
	onclick event handler: More...
	position
	If position is "fixed", then this shape will not scroll with its canvas. More...
	preserveAspectRatio
	Value to apply for this component's enclosing svg element's. More...
	svgComponent
	Client-side property used to determine if a component is an SVG component. More...
	svgGroup
	Client-side property that points to the enclosing SVG group element for this component. More...
	viewBoxHeight
	If defined, this is used to calculate the height of the. More...
	viewBoxWidth
	If defined, this is used to calculate the width of the. More...
	width
	Width of this component. More...
	x
	x position of this component's enclosing group. More...
	y
	y position of this component's enclosing group. 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 svgComponent
	DEFAULTASPECT = None
	Subclasses can set this to change the default value for the <property>preserveAspectRatio/<property> property for a component.
	DEFAULTBOUNDLESS = None
	Subclasses can set this to change the default value for the <property>boundless</property> property for a component.
	DEFAULTHEIGHT = None
	Default height of this component.
	DEFAULTHIDDEN = None
	Subclasses can set this to change the default value for the <property>hidden</property> property for a component.
	DEFAULTVIEWBOXHEIGHT = None
	Default viewBoxHeight of this component.
	DEFAULTVIEWBOXWIDTH = None
	Default viewBoxWidth of this component.
	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.
	DEFAULTWIDTH = None
	Default width of this component.
	POSTCOMPILEACTIONS = None
	Internal parameter.
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

SVG TimeLine component.

This displays a series of "events" along a time line.

Member Function Documentation

renderOneItem()

renderOneItem	(		group,
			item,
			length,
			size
	)

Render one item on the timeline.

group is the svg group to append to. length is the length (in pixels) of the time range to plot.. Return the size of the rendered item via size.

setTimeRange()

setTimeRange	(		startTime,
			endTime,
			reset,
			which
	)

Set the timeline start and end dates and update.

Time values are in 'yyyy-mm-dd' format. This prevents the repaint that would happen if start and end dates are set separately. If endTime is not provided, update it to preserve the current time range using startTime as a new starting time.
If reset is true, clear the internal structures used to compute the locations of the time events.
If which is provided, it specifies whether the change is "translate" or "scale" (to make it easy to connect to a timeRange controller).

sortModel()

sortModel	(		model,
			range
	)

Take the user-supplied data model and sort it by time.

Return a sorted and decorated model. Also find earliest and latest times and return via range object.

Member Data Documentation

birthDate

birthDate

"Birth date" (as YYYY-MM-DD HH:MM:SS).

If provided, then a time bar showing current age is also displayed.  

dateFormat

dateFormat

Optional.

Specifies the display format used for this component.

(Note that the internal value of this control is always YYYY-MM-DD). Possible values are:

• "YMD" - Year,Month,Day
• "MDY" - Month,Day,Year
• "DMY" - Day,Month,Year

 

endTime

endTime

Latest displayed time (as YYYY-MM-DD HH:MM:SS).

 

marginLeft

marginLeft

Left margin (in pixels).

 

marginRight

marginRight

Right margin (in pixels).

 

ongetdata

ongetdata

ongetdata event handler:

This defines the client-side code that returns an graph of javascript objects used to provide the contents of this view.  

onrenderitem

onrenderitem

onrenderitem event handler:

This event handler is called when an event is plotted and makes it possible to plot custom content on the time line.  

onselect

onselect

onselect event handler:

This event handler is called when the user selects a new item within the timeline.  

selectedId

selectedId

Id of selected item.

 

spanHeight

spanHeight

Height (in pixels) of a time span box on the time line.

 

startTime

startTime

Earliest displayed time (as YYYY-MM-DD HH:MM:SS).

 

title

title

Chart title.