IRISLIB database
timeRangeControl Class Reference

SVG time range control. More...

Inheritance diagram for timeRangeControl:
Collaboration diagram for timeRangeControl:

Public Member Functions

 dragGrabber (evt, which)
 Drag handler for grabber.
 
 dragThumb (evt)
 Drag handler for thumb.
 
 getTimeForPos (x)
 Return the time value (as yyyy-mm-dd [hh]) for the given x position on the time line.
 
 onchangeHandler (final, which)
 Raise onchange event.
 
 onconfigHandler ()
 Raise onconfig event.
 
 renderContents ()
 Render the inner SVG contents of this component.
 
 reset ()
 Reset the timeline to its initial state.
 
 scrollBtnClick (evt, which)
 Click on scroll button.
 
 scrollBtnOut (evt, which)
 Mouse out of scroll button.
 
 scrollBtnOver (evt, which)
 Mouse over scroll button.
 
 setProperty (property, value, value2)
 Set the value of a named property.
 
 setTimeRange (startRange, endRange)
 Set the start and end time range dates and update. More...
 
 unitRectClick (evt, which)
 Mouse click on cell rect.
 
 unitRectOut (evt, which)
 Mouse out of cell rect.
 
 unitRectOver (evt, which)
 Mouse over cell rect.
 
 updateScrollbar ()
 Resize all elements related to current range.
 
- 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

 dateFormat
 Optional. More...
 
 endRange
 End of current time range (as YYYY-MM-DD HH:MM:SS). More...
 
 endTime
 Latest time displayed on the time line (as YYYY-MM-DD HH:MM:SS). More...
 
 onchange
 onchange event handler: More...
 
 onconfig
 This event handler is fired when the user clicks on the config icon (which. More...
 
 startRange
 Start of current time range (as YYYY-MM-DD HH:MM:SS). More...
 
 startTime
 Earliest time displayed on the time line (as YYYY-MM-DD HH:MM:SS). More...
 
 thumbStyle
 SVG style applied to "thumb" of scroll bar. More...
 
 timeNotation
 Time notation used for time values. More...
 
 timeScale
 Time scale to display. 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 time range control.

This lets a user select a range of dates along a simple time line. This is typically used to control another component, such as a chart or time line.
The selected date range is specified by the <property>startRange</property> and <property>endRange</property> properties. These are modified as the user interacts with the control.
The <property>onchange</property> event will be fired whenever the user modifies the time range.
The height of this component should be set to 40.

Member Function Documentation

◆ setTimeRange()

setTimeRange (   startRange,
  endRange 
)

Set the start and end time range dates and update.

If endRange is not provided, update it to preserve the current time range using startRange as a new starting time.
Time values are in 'yyyy-mm-dd' format.

Member Data Documentation

◆ 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

 

◆ endRange

endRange

End of current time range (as YYYY-MM-DD HH:MM:SS).

This is modified as the user interacts with the control.  

◆ endTime

endTime

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

Rounded to current time scale.

 

◆ onchange

onchange

onchange event handler:

This event handler is called as the user changes the value of this control. The final parameter is passed to this event indicating if the value is the final value (at the end of the current action). The which parameter is passed to this event indicating how the value as been changed: 'translate' (move to new start time), or 'scale' (change in time scale).  

◆ onconfig

onconfig

This event handler is fired when the user clicks on the config icon (which.

is only displayed if this event is defined).  

◆ startRange

startRange

Start of current time range (as YYYY-MM-DD HH:MM:SS).

This is modified as the user interacts with the control.  

◆ startTime

startTime

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

Rounded to current time scale.

 

◆ thumbStyle

thumbStyle

SVG style applied to "thumb" of scroll bar.

 

◆ timeNotation

timeNotation

Time notation used for time values.

 

◆ timeScale

timeScale

Time scale to display.