Skip to main content
PREV CLASS NEXT CLASS FRAMES NO FRAMES

 

Class IlvGanttSheetView

IlvObject
   |
   +--IlvEmptyView
      |
      +--IlvResizableView
         |
         +--IlvAbstractView
            |
            +--IlvGanttComponentView
               |
               +--IlvGanttSheetView

Category:
Gantt Chart component
JavaScript File:
IlvGanttView.js
Description:
An IlvGanttSheetView is a DHTML component that displays an image of a Gantt sheet. The image is obtained from an IlvGanttServlet running on the server. You must call the setServletURL() method to set the URL of the servlet.

Constructor Summary
Constructor Attributes Constructor Name and Description
 
IlvGanttSheetView(left, top, width, height, reload, namespace)
Method Summary
Method Attributes Method Name and Description
 
Creates the HTTP request for capabilities.
 
Returns the IlvGanttSheetSelectionManager for this view.
 
Returns the current time interval displayed by the sheet.
 
Returns the factor used when calling the zoomIn and zoomOut methods.
 
scrollTo(startTime, y)
Queries a new image showing the image 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.
 
setVisibleInterval(startTime, endTime)
Queries a new image showing the specified time interval.
 
setZoomFactor(factor)
Sets the factor used when calling the zoomIn and zoomOut methods.
 
Queries the server for a new image.
 
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.
 
Zooms the view out by querying a new image from the server.
 
Zooms the view to fit the data by querying a new image from the server.
Methods inherited from class IlvGanttComponentView
addCapabilitiesLoadListener, addErrorListener, addImageLoadingListener, addImageLoadListener, addImagePreloadListener, addInteractorListener, addTimeoutErrorListener, addVerticalScrollListener, childrenToHTML, createImageRequestURL, dispose, getAgainParam, getBlendTransform, getCapabilities, getDateParam, getGanttView, getImageFormat, getImageScrollPosition, getMaxVerticalScrollPosition, getMessagePanel, getPopupMenu, getServletURL, getSiblingViews, getTimeoutErrorInterval, getUpdateImageOnResize, getUpdateInterval, getVerticalScrollPosition, getWaitingImage, init, isAutoUpdateCapabilities, isCapabilitiesLoaded, isImageLoaded, isVisible, keyDown, keyPress, keyUp, mouseDown, mouseDrag, mouseMove, mouseOut, mouseOver, mouseUp, onCapabilitiesLoaded, performAction, readAdditionalCapabilities, removeCapabilitiesLoadListener, removeErrorListener, removeImageLoadListener, removeImagePreloadListener, removeInteractorListener, removeTimeoutErrorListener, setAutoUpdateCapabilities, setBlendTransform, setChildrenBounds, setImageFormat, setImageScrollPosition, setMessagePanel, setPopupMenu, setServletURL, setTimeoutErrorInterval, setUpdateInterval, setVerticalScrollPosition, setVisible, setWaitingImage, startErrorTimer, startUpdateTimer, stopErrorTimer, stopUpdateTimer, timeoutError, trimScrollPosition, updateAll
Methods inherited from class IlvAbstractView
getCursor, getGlassView, getHitInfos, getHitInfoTypes, getInteractor, putHitInfoType, setAccessible, setAdditionalParameters, setCursor, setHitmapLayers, setInteractor, setScrollBarSize, setScrollBarState
Methods inherited from class IlvResizableView
getMaximumSize, getMinimumSize, isResizable, setHotkeys, 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
getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility
Constructor Detail
IlvGanttSheetView
IlvGanttSheetView(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 IlvGanttSheetViews 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 IlvGanttSheetView(..., window.name);
                  
Method Detail
createCapabilitiesRequestURL
createCapabilitiesRequestURL()
Creates the HTTP request for capabilities. Overriden to fix JV-6684.

getSelectionManager
getSelectionManager()
Returns the IlvGanttSheetSelectionManager for this view.

This manager allows to prevent an image query on each selection. It queries the server for selection updates and displays rectangles to represent the selection.

The most common use of this method are:

The selection manager is lazilly created. As a consequence, the current server selection is not shown on the client before a first call to this method.

Since:
JViews 8.0

getVisibleInterval
getVisibleInterval()
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.

getZoomFactor
getZoomFactor()
Returns the factor used when calling the zoomIn and zoomOut methods.

scrollTo
scrollTo(startTime, y)
Queries a new image showing the image scrolled to the specified position.
Parameters:
startTime - The visible start time, as a Date.
y - The vertical scroll position.

scrollToDay
scrollToDay(date, delta)
Queries a new image showing the specified day.
Parameters:
date - The Date object that specifies the day to be displayed.
delta - The optional day offset from the specified date.

scrollToMonth
scrollToMonth(date, delta)
Queries a new image showing the specified month.
Parameters:
date - The Date object that specifies the month to be displayed.
delta - The optional month offset from the specified date.

scrollToWeek
scrollToWeek(date, delta)
Queries a new image showing the specified week.
Parameters:
date - The Date object that specifies the week to be displayed.
delta - The optional week offset from the specified date.

scrollToYear
scrollToYear(date, delta)
Queries a new image showing the specified year.
Parameters:
date - The Date object that specifies the year to be displayed.
delta - The optional year offset from the specified date.

setVisibleInterval
setVisibleInterval(startTime, endTime)
Queries a new image showing the specified time interval.
Parameters:
startTime - The visible start time, as a Date.
endTime - The visible end time, as a Date.

setZoomFactor
setZoomFactor(factor)
Sets the factor used when calling the zoomIn and zoomOut methods. The default value is 1.5.
Parameters:
factor

updateImage
updateImage()
Queries the server for a new image. Overriden to fix JV-6684: in some cases we need to refresh the table when the visible interval changes in the Gantt sheet.

zoomBy
zoomBy(z)
Zooms the view to a specified factor by querying a new image from the server.
Parameters:
z - The zoom factor.

zoomIn
zoomIn()
Zooms the view in by querying a new image from the server.

zoomOut
zoomOut()
Zooms the view out by querying a new image from the server.

zoomToFit
zoomToFit()
Zooms the view to fit the data by querying a new image from the server.

©Copyright 2024 Rogue Wave Software, Inc., a Perforce company.. All Rights Reserved.