Skip to main content
PREV CLASS NEXT CLASS FRAMES NO FRAMES

 

Class IlvHierarchyChartViewProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy
         |
         +--IlvSizedViewProxy
            |
            +--IlvBasicViewProxy
               |
               +--IlvHierarchyChartViewProxy

Category:
Gantt JSF component
JavaScript File:
IlvHierarchyChartViewProxy.js
Description:
The IlvHierarchyChartViewProxy is the proxy that handles an IlvGanttView subclass DHTML object.

Constructor Summary
Constructor Attributes Constructor Name and Description
 
IlvHierarchyChartViewProxy(clientId, refNodeId, width, height, divider, startTime, endTime, reload)
Method Summary
Method Attributes Method Name and Description
 
IlvHierarchyChartViewProxy. capabilitiesLoaded(view)
internal implementation
 
Returns whether the automatic update will also update the capabilities.
 
Returns the message that will be displayed during a column resize.
 
Returns the identifier of the data source to be displayed, if defined.
 
Returns the location of the divider as the number of pixels from the left side of the view.
 
Returns the end time of the visible interval.
 
Returns the error message displayed by the view when an error occurred during the image loading.
 
Returns the maximum vertical scroll position.
 
getPopupMenu(popupMenu)
Returns the specified contextual pop-up menu set on this view.
 
Returns the diagrammer project of this diagrammer if set.
 
Returns the extent of the move when one click on the background of the horizontal scrollbar.
 
Returns the interactor set on the sheet view.
 
Returns the identifier of the interactor set on the sheet view.
 
Returns the IlvSheetView component of this view.
 
Returns the start time of the visible interval.
 
Returns the style sheet.
 
Returns the style sheets.
 
Returns the interactor set on the table view.
 
Returns the identifier of the interactor set on the table view.
 
Returns the IlvTableView component of this view.
 
Returns the automatic update interval (in seconds) of the Gantt.
 
Returns the vertical scroll position of the chart.
 
Returns the current time interval displayed by the sheet.
 
Returns the factor used when calling the zoomIn and zoomOut methods.
 
IlvHierarchyChartViewProxy. imageLoaded(view)
internal implementation
 
Returns whether the managed view is resizable or not.
 
Returns whether the sheet view is horizontal scrollable.
 
Returns whether the sheet view is vertical scrollable.
 
performJSFAction(mb, params, updateAll)
Performs an predefined action that will invoke the specified method binding.
 
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)
Sets whether the managed view is accessible or not.
 
setAutoUpdateCapabilities(autoUpdateCapabilities)
Sets whether the automatic update will also update the capabilities.
 
Sets the message that will be displayed during a column resize.
 
setDataSourceId(dataSourceId, updateImage)
Sets the identifier of the data source to be displayed by the chart.
 
setDividerLocation(dividerLocation, update)
Sets the location of the divider as the number of pixels from the left side of the view.
 
setEndVisibleInterval(startTime, endTime)
Queries a new image showing the specified end time interval.
 
setErrorMessage(errorMessage)
The error message displayed by the view when an error occurred during the image loading.
 
setHotkeys(hotkeys)
Sets the keyboard hotkeys for the view.
 
setInteractors(tableInteractor, sheetInteractor)
Sets the interactors on the table and the sheet view.
 
setPopupMenu(popupMenu)
Sets the specified contextual pop-up menu on this view.
 
setProject(project, update)
The project property.
 
setResizable(resizable)
Sets whether the managed view is resizable or not.
 
setSheetHScrollable(scrollable)
Sets the sheet view horizontal scrollable.
 
Sets the extent of the move when one click on the background of the horizontal scrollbar.
 
setSheetInteractor(interactor)
Sets the interactor on the sheet view.
 
setSheetVScrollable(scrollable)
Sets the sheet view vertical scrollable.
 
Sets hide view for hierarchy chart view.
 
setStartVisibleInterval(startTime, endTime)
Queries a new image showing the specified start time interval.
 
setStyleSheet(css, update)
Sets the style sheet to set.
 
setStyleSheets(css, update)
Sets the style sheets to set.
 
setTableInteractor(interactor)
Sets the interactor on the table view.
 
setUpdateInterval(updateInterval)
The automatic update interval (in seconds) of the Gantt.
 
Queries a new image showing the chart scrolled to the specified vertical position.
 
setVisibleInterval(startTime, endTime, update)
Queries a new image showing the specified time interval.
 
setZoomFactor(factor)
Sets the factor used when calling the zoomIn and zoomOut methods.
 
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 IlvBasicViewProxy
getImageFormat, getMessageBox, getServletClass, getServletURL, getWaitingImage, init, setImageFormat, setMessageBox, setServletClass, setServletURL, setWaitingImage
Methods inherited from class IlvSizedViewProxy
afterLayoutHandler, getAbsoluteBounds, getBounds, getCreationSize, getHeight, getMinimumSize, getWidth, positionAfterLayout, registerResizeListener, resizeAfterLayout, setMinimumSize
Methods inherited from class IlvFacesProxy
dispose, getAbsoluteId, getJViewsDHTMLObject, getNodeCoords, getObject, getReferenceNode, setAbsoluteId, setJViewsDHTMLObject, setObject, setPageIdSupport, setReferenceNode, toHTML
Methods inherited from class IlvPropertyStateManager
getClientId, notify
Methods inherited from class IlvObject
getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility
Constructor Detail
IlvHierarchyChartViewProxy
IlvHierarchyChartViewProxy(clientId, refNodeId, width, height, divider, startTime, endTime, reload)
Parameters:
clientId
refNodeId
width
height
divider
startTime
endTime
reload
Method Detail
capabilitiesLoaded
<static> IlvHierarchyChartViewProxy.capabilitiesLoaded(view)
internal implementation
Parameters:
view

getAutoUpdateCapabilities
getAutoUpdateCapabilities()
Returns whether the automatic update will also update the capabilities.
Returns:
The autoUpdateCapabilities flag.

getColumnResizeMessage
getColumnResizeMessage()
Returns the message that will be displayed during a column resize.

getDataSourceId
getDataSourceId()
Returns the identifier of the data source to be displayed, if defined.
Returns:
The data source identifier.

getDividerLocation
getDividerLocation()
Returns the location of the divider as the number of pixels from the left side of the view.

getEndVisibleInterval
getEndVisibleInterval(start)
Returns the end time of the visible interval.
Parameters:
start - not really used.

getErrorMessage
getErrorMessage()
Returns the error message displayed by the view when an error occurred during the image loading.
Returns:
The error message.

getMaxVerticalScrollPosition
getMaxVerticalScrollPosition()
Returns the maximum vertical scroll position.

getPopupMenu
getPopupMenu(popupMenu)
Returns the specified contextual pop-up menu set on this view.
Parameters:
popupMenu
Returns:
The contextual pop-up menu.

getProject
getProject()
Returns the diagrammer project of this diagrammer if set.
Returns:
The project.

getSheetHScrollBackgroundClickExtent
getSheetHScrollBackgroundClickExtent()
Returns the extent of the move when one click on the background of the horizontal scrollbar.

getSheetInteractor
getSheetInteractor()
Returns the interactor set on the sheet view.

getSheetInteractorId
getSheetInteractorId()
Returns the identifier of the interactor set on the sheet view.

getSheetView
getSheetView()
Returns the IlvSheetView component of this view.
Since:
JViews 8.0

getStartVisibleInterval
getStartVisibleInterval(start)
Returns the start time of the visible interval.
Parameters:
start

getStyleSheet
getStyleSheet()
Returns the style sheet.

getStyleSheets
getStyleSheets()
Returns the style sheets.

getTableInteractor
getTableInteractor()
Returns the interactor set on the table view.

getTableInteractorId
getTableInteractorId()
Returns the identifier of the interactor set on the table view.

getTableView
getTableView()
Returns the IlvTableView component of this view.
Since:
JViews 8.0

getUpdateInterval
getUpdateInterval()
Returns the automatic update interval (in seconds) of the Gantt.
An interval of zero means no automatic interval.
Returns:
The update interval.

getVerticalScrollPosition
getVerticalScrollPosition()
Returns the vertical scroll position of the chart.

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.

imageLoaded
<static> IlvHierarchyChartViewProxy.imageLoaded(view)
internal implementation
Parameters:
view

isResizable
isResizable()
Returns whether the managed view is resizable or not.

isSheetHScrollable
isSheetHScrollable()
Returns whether the sheet view is horizontal scrollable.

isSheetVScrollable
isSheetVScrollable()
Returns whether the sheet view is vertical scrollable.

performJSFAction
performJSFAction(mb, params, updateAll)
Performs an predefined action that will invoke the specified method binding.

This action will be executed before the image generation.
The signature of the method must be void methodName (IlvHierarchyChart, String[]) where the first parameter is the IlvHierarchyChart instance that renders the image and the second parameter is the array of action parameters. The action must only change the IlvHierarchyChart instance as only the image is refreshed (the JSF components are not).

Parameters:
mb - The method binding to invoke
params - The action parameters as a array of Strings.
updateAll - Whether update the capabilities and the image or only the image
Since:
JViews 8.0

scrollTo
scrollTo(startTime, y)
Queries a new image showing the sheet 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

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

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

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

setAccessible
setAccessible(accessible)
Sets whether the managed view is accessible or not.
Parameters:
accessible - The accessible flag.

setAutoUpdateCapabilities
setAutoUpdateCapabilities(autoUpdateCapabilities)
Sets whether the automatic update will also update the capabilities.
Parameters:
autoUpdateCapabilities - The autoUpdateCapabilities flag to set.

setColumnResizeMessage
setColumnResizeMessage(message)
Sets the message that will be displayed during a column resize.
Parameters:
message - The message to set.

setDataSourceId
setDataSourceId(dataSourceId, updateImage)
Sets the identifier of the data source to be displayed by the chart.
Parameters:
dataSourceId - The data source identifier.
updateImage - Flag to request a new image from the generating image servlet.

setDividerLocation
setDividerLocation(dividerLocation, update)
Sets the location of the divider as the number of pixels from the left side of the view.
Parameters:
dividerLocation
update

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

setErrorMessage
setErrorMessage(errorMessage)
The error message displayed by the view when an error occurred during the image loading.
Parameters:
errorMessage - The error message to set.

setHotkeys
setHotkeys(hotkeys)
Sets the keyboard hotkeys for the view.
Parameters:
hotkeys - The hotkeys to set.

setInteractors
setInteractors(tableInteractor, sheetInteractor)
Sets the interactors on the table and the sheet view.
It's similar to a call to setTableInteractor(tableInteractor) and setSheetInteractor(sheetInteractor).
Parameters:
tableInteractor - The interactor to set on the table view, or null to remove the current interactor on the table view.
sheetInteractor - The interactor to set on the sheet view, or null to remove the current interactor on the sheet view.

setPopupMenu
setPopupMenu(popupMenu)
Sets the specified contextual pop-up menu on this view.
Parameters:
popupMenu - The contextual pop-up menu.

setProject
setProject(project, update)
The project property.
Parameters:
project - The project to set.
update - A string indicating which kind of update to perform after the project change. You can pass updateAll to update image, capabilities and overview or updateImage to update only the image.

setResizable
setResizable(resizable)
Sets whether the managed view is resizable or not.
Parameters:
resizable - The resizable flag.

setSheetHScrollable
setSheetHScrollable(scrollable)
Sets the sheet view horizontal scrollable.
Parameters:
scrollable

setSheetHScrollBackgroundClickExtent
setSheetHScrollBackgroundClickExtent(extent)
Sets the extent of the move when one click on the background of the horizontal scrollbar. The default value is 0.95.
Parameters:
extent

setSheetInteractor
setSheetInteractor(interactor)
Sets the interactor on the sheet view.
Parameters:
interactor - The interactor to set on the view, or null to remove the current interactor.

setSheetVScrollable
setSheetVScrollable(scrollable)
Sets the sheet view vertical scrollable.
Parameters:
scrollable

setSplitterArrowsVisible
setSplitterArrowsVisible(hideView)
Sets hide view for hierarchy chart view.
Parameters:
hideView - the name of hide view(table or sheet).
Since:
JViews8.8

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

setStyleSheet
setStyleSheet(css, update)
Sets the style sheet to set.
At the next request the style sheet will be set to the displayed diagrammer.
Parameters:
css - The style sheet to apply.
update - A flag indicating if the view and capabilities should be updated.

setStyleSheets
setStyleSheets(css, update)
Sets the style sheets to set.
At the next request the style sheets will be set to the displayed diagrammer.
Parameters:
css - The style sheets to apply.
update - A flag indicating if the view and capabilities should be updated.

setTableInteractor
setTableInteractor(interactor)
Sets the interactor on the table view.
Parameters:
interactor - The interactor to set on the view, or null to remove the current interactor.

setUpdateInterval
setUpdateInterval(updateInterval)
The automatic update interval (in seconds) of the Gantt. An interval of zero means no automatic interval.
Parameters:
updateInterval - The update interval to set.

setVerticalScrollPosition
setVerticalScrollPosition(y)
Queries a new image showing the chart scrolled to the specified vertical position.
Parameters:
y - The vertical scroll position.

setVisibleInterval
setVisibleInterval(startTime, endTime, update)
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.
update

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

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.