Perforce JViews Gantt JavaScript Reference: Class IlvPanel

Class IlvPanel

IlvObject
   |
   +--IlvPanel

Category:: Common component

JavaScript File:: IlvUtil.js

Description:: This class is an abstract class that cannot be used as is. It contains generic methods that are common to its subclasses. It defines a rectangular area on the Web page that can be filled with any kind of content. This class is to be considered as a low-level graphic component. It is not meant to be instantiated directly. Use one of its subclasses, IlvHTMLPanel or IlvURLPanel, instead.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvPanel(left, top, width, height)

Method Summary
Method Attributes	Method Name and Description
	dispose() Disposes of all resources being used by the panel.
	getBounds() Returns the bounds of this `IlvPanel`.
	getClip() Returns the clip of this `IlvPanel`.
	getCursor() Returns the mouse cursor that is displayed when the mouse is over this panel.
	getHeight() Returns the height of this `IlvPanel`.
	getLeft() Returns the position of the left border of this `IlvPanel`.
	getMouseEventSource() Returns the object that catches each mouse event sent by the browser to this panel.
	getScrollPosition() Returns the scroll of this `IlvPanel`.
	getTop() Returns the position of the top border of this `IlvPanel`.
	getWidth() Returns the width of this `IlvPanel`.
	getZIndex() Returns the 'z' coordinate of the panel.
	isVisible() Returns the visibility of this `IlvPanel`.
	setBackgroundColor(color) Sets the background color of this `IlvPanel`.
	setBackgroundImage(image) Sets the background image of this `IlvPanel`.
	setBounds(left, top, width, height) Reshapes this `IlvPanel`.
	setClip(left, top, width, height) Sets the clip of this panel.
	setCursor(cursor) Sets the mouse cursor that is displayed when the mouse is over this panel.
	setLocation(left, top) Moves this `IlvPanel` to the specified location.
	setScrollPosition(x, Y) Sets the scroll position of this `IlvPanel`.
	setSize(width, height) Sets the size of this `IlvPanel`.
	setVisible(visible) Sets the visibility of this `IlvPanel`.
	setZIndex(the) Set the 'z' coordinate of the panel.
	translate(dx, dy) Moves this `IlvPanel` according to the specified amount of pixels.

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

Constructor Detail

IlvPanel

IlvPanel(left, top, width, height)

Parameters:: left; top; width; height

Method Detail

dispose

dispose()

Disposes of all resources being used by the panel. Make sure to call IlvObject.callDispose() function on the onunload event of the page:

 <body onunload="IlvObject.callDispose()">

getBounds

getBounds()

Returns the bounds of this IlvPanel. Note: You are not allowed to modify the object returned by this method. To modify the bounds of a panel, use the setBounds method.

Returns:: An object with four properties: left, top, width, and height. These properties represent the bounds of this IlvPanel expressed in the coordinates of the browser window.

getClip

getClip()

Returns the clip of this IlvPanel. Note: You are not allowed to modify the object returned by this method. To modify the clip of a panel, use the setClip method.

Returns:: An object with four properties: left, top, width, and height.These properties represent the clip of this panel expressed in the coordinates of the panel.

getCursor

getCursor()

Returns the mouse cursor that is displayed when the mouse is over this panel.

getHeight

getHeight()

Returns the height of this IlvPanel.

getLeft

getLeft()

Returns the position of the left border of this IlvPanel.

getMouseEventSource

getMouseEventSource()

Returns the object that catches each mouse event sent by the browser to this panel. This object can be associated with the following callbacks for processing mouse events: onmouseover, onmouseout, onmousedown, onmouseup, and onmousemove. Note: The way events are dispatched to the panels and the properties of the mouse events are not independent of the browser. Therefore, this method is not supposed to be used directly, but by the view when an interactor is set to an IlvView object. As a consequence, we recommend that you use the view-interactor architecture instead of using the object returned by this method directly.

getScrollPosition

getScrollPosition()

Returns the scroll of this IlvPanel. Note: You are not allowed to modify the object returned by this method. To modify the scroll position of a panel, use the setScrollPosition method.

Returns:: An object with two properties: x and y.

getTop

getTop()

Returns the position of the top border of this IlvPanel.

getWidth

getWidth()

Returns the width of this IlvPanel.

getZIndex

getZIndex()

Returns the 'z' coordinate of the panel. By default the value is set to 1

Returns:: the z-index

isVisible

isVisible()

Returns the visibility of this IlvPanel.

setBackgroundColor

setBackgroundColor(color)

Sets the background color of this IlvPanel. Note: By default, a panel has no background color and is therefore transparent.

Parameters:: color - A string describing the color. For example, "#FFFFFF" corresponds to white.

setBackgroundImage

setBackgroundImage(image)

Sets the background image of this IlvPanel. The image is tiled across the background of the panel. Note: By default, a panel has no background image and is therefore transparent.

Parameters:: image - The URL of an image.

setBounds

setBounds(left, top, width, height)

Reshapes this IlvPanel. This method is a shortcut for setLocation and setSize.

Parameters:: left; top; width; height

setClip

setClip(left, top, width, height)

Sets the clip of this panel.

Parameters:: left - Position of the left side, relative to the upper-left corner of the panel.; top - Position of the top side, relative to the upper-left corner of the panel.; width - The width of the clip in pixels.; height - The height of the clip in pixels.

setCursor

setCursor(cursor)

Sets the mouse cursor that is displayed when the mouse is over this panel.

Parameters:: cursor - A string representing the cursor type according to the specifications of the Cascading Style Sheets (CSS).

setLocation

setLocation(left, top)

Moves this IlvPanel to the specified location.

Parameters:: left - Position of the left side, relative to the upper-left corner of the window.; top - Position of the top side, relative to the upper-left corner of the window.

setScrollPosition

setScrollPosition(x, Y)

Sets the scroll position of this IlvPanel.

Parameters:: x - The scroll position along the x-axis, relative to the top of the panel.; Y - The scroll position along the y-axis, relative to the left side of the panel.

setSize

setSize(width, height)

Sets the size of this IlvPanel. Note: This method also resets the clip.

Parameters:: width - The width of the panel in pixels.; height - The height of the panel in pixels.

setVisible

setVisible(visible)

Sets the visibility of this IlvPanel.

Parameters:: visible

setZIndex

setZIndex(the)

Set the 'z' coordinate of the panel. By default the value is set to 1

Parameters:: the - z-index

translate

translate(dx, dy)

Moves this IlvPanel according to the specified amount of pixels.

Parameters:: dx; dy