Perforce JViews Gantt JavaScript Reference: Class IlvGanttView

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvGanttView(left, top, width, height, reload, namespace)

Method Summary
Method Attributes	Method Name and Description
	childrenToHTML(parentNode) Creates the HTML for this component's children.
	getDividerLocation() Returns the location of the divider as the number of pixels from the left side of the view.
	getImageFormat() Returns the image format that the server will use for responses to this view.
	getMaxDividerLocation() Returns the maximum location of the divider.
	getMaxVerticalScrollPosition() Returns the maximum vertical scroll position.
	getMessagePanel() Returns the message panel where the messages will be displayed.
	getMinDividerLocation() Returns the minimum location of the divider.
	getPopupMenu() Returns the pop-up menu on set this view.
	getServletURL() Returns the URL of the servlet as set using `setServletURL`.
	getSheetHScrollBackgroundClickExtent() Returns the extent of the move when one click on the background of the horizontal scrollbar.
	getSheetView() Returns this Gantt view's `IlvGanttSheetView` child view.
	getTableView() Returns this Gantt view's `IlvGanttTableView` child view.
	getTimeoutErrorInterval() Returns the timeout interval for requests to the server, in seconds.
	getUpdateInterval() Returns the automatic update interval of the view, in seconds.
	getVerticalScrollPosition() Returns the vertical scroll position of the chart.
	getVisibleInterval() Returns the current time interval displayed by the sheet.
	getWaitingImage() Returns the URL of the image used to show that the component is waiting for a server response.
	getZoomFactor() Returns the factor used when calling the `zoomIn` and `zoomOut` methods.
	init() Initializes the view.
	isSheetHScrollable() Returns whether sheet horizental scrollbar is scrollable.
	isSheetVScrollable() Returns whether sheet vertical scrollbar is scrollable.
	removeAdditionalParameter(key) Removes an additional parameter in both the table view and the sheet view.
	resetSessionExpirationTimer() Resets the timer that will invoke the session expiration handler.
	scrollTo(startTime, y) Queries a new image showing the sheet scrolled to the specified position.
	scrollToDay(date, delta) Queries a new image showing the specified day.
	scrollToMonth(date, delta) Queries a new image showing the specified month.
	scrollToWeek(date, delta) Queries a new image showing the specified week.
	scrollToYear(date, delta) Queries a new image showing the specified year.
	setAccessible(accessible) Set whether this view is accessible or not.
	setAdditionalParameters(key, value) Sets the additional parameters on both the table view and the sheet view.
	setChildrenBounds(left, top, width, height) Changes the size of this view's children.
	setDividerLocation(location) Sets the location of the divider as the number of pixels from the left side of the view.
	setHotkeys(hotkeys)
	setImageFormat(format) Sets the image format that the server will use for responses to this view.
	setMessagePanel(ilvHTMLPanel) Sets the message panel where the message will be displayed.
	setPopupMenu(pop-up) Sets the pop-up menu on this view.
	setScrollBarSize(scrollBarSize) Sets the size of scroll bar.
	setServletURL(servletURL) Sets the URL of the servlet that the view will send requests to.
	setSessionExpirationHandler(handler) Sets a listener that will be called when the HTTP session is about to be invalidated.
	setSheetHScrollable(scrollable) Sets sheet view can scroll horizontally by horizon scrollbar or not.
	setSheetHScrollBackgroundClickExtent(extent) Sets the extent of the move when one click on the background of the horizontal scrollbar.
	setSheetVisible(visible) Set gantt sheet view to be visible or not.
	setSheetVScrollable(scrollable) Sets sheet view can scroll vertically by vertical scrollbar or not.
	setSplitterArrowsVisible(visible) Sets the arrows of splitter of gantt view visible or not, these arrows are used for set table and sheet visible.
	setTableVisible(visible) Set gantt table view to be visible or not.
	setTimeoutErrorInterval(interval) Sets the timeout interval for requests to the server.
	setUpdateInterval(rate) Sets the automatic update interval of the view.
	setVerticalScrollPosition(y) Queries a new image showing the chart scrolled to the specified vertical position.
	setVisibleInterval(startTime, endTime) Queries a new image showing the specified time interval.
	setWaitingImage(image) Sets the URL of the image used to show that the component is waiting for a server response.
	setZoomFactor(factor) Sets the factor used when calling the `zoomIn` and `zoomOut` methods.
	updateAll() Queries new capabilities and a new images from the server.
	updateImage() Queries the server for new images.
	zoomBy(z) Zooms the view to a specified factor by querying a new image from the server.
	zoomIn() Zooms the view in by querying a new image from the server.
	zoomOut() Zooms the view out by querying a new image from the server.
	zoomToFit() Zooms the view to fit the data by querying a new image from the server.

Methods inherited from class IlvResizableView
getMaximumSize, getMinimumSize, isResizable, setMaximumSize, setMinimumSize, setResizable, toHTML

Methods inherited from class IlvEmptyView
addSizeListener, getBounds, getHeight, getLeft, getLocation, getSize, getTop, getWidth, isStateInCookie, removeSizeListener, restoreState, saveState, setBounds, setLocation, setSize, setStateInCookie

Methods inherited from class IlvObject
dispose, getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility

Constructor Detail

IlvGanttView

IlvGanttView(left, top, width, height, reload, namespace)

Parameters:

left - The absolute x position of the view on the page.

top - The absolute y position of the view on the page.

width - The width of the view.

height - The height of the view.

reload - An optional Boolean value that specifies whether the view should be initialized from a temporary cookie that persists for the current browser session. When omitted, defaults to false.

namespace - An optional parameter to place the view in a namespace. This is useful when using IlvGanttViews in multiple browser windows or in multiple frames of a frameset and the views must store cookies that should not conflict with each other. In this case, use the namespace to uniquely identify the views that belong to a specific browser window or frameset frame. For example, if you have created a new window with a unique name:


                    open(childPageURL, uniqueWindowName, ...);

you can then use the window name to define the namespace for views within the child page:


                    var view = new IlvGanttView(..., window.name);

Returns the current time interval displayed by the sheet. This method returns an object with three properties: start and end are Date values that give the start and end of the time interval. The third property is duration. It is an integer value that gives the interval duration in milliseconds.

Returns the URL of the image used to show that the component is waiting for a server response. The default value is the image: IlvConstants.ilvImagePath + "wait.gif", where IlvConstants.ilvImagePath = "script/images/".

Sets a listener that will be called when the HTTP session is about to be invalidated.

This method works if and only if the session inactivity is reset by a JViews request. If the session inactivity is reset by an external request, the #resetSessionExpirationTimer method must be called.

This method must be called before the capabilities request is made.

Sets the URL of the image used to show that the component is waiting for a server response. The image may be an animated GIF. The default value is the image: IlvConstants.ilvImagePath + "wait.gif", where IlvConstants.ilvImagePath = "script/images/".