Perforce JViews Gantt JavaScript Reference: Class IlvZoomTool

Class IlvZoomTool

IlvObject
   |
   +--IlvEmptyView
      |
      +--IlvZoomTool

Category:: Graphics Framework component

JavaScript File:: IlvZoomTool.js

Description:: The IlvZoomTool component displays several buttons vertically or horizontally, each button corresponding to a zoom level.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvZoomTool(left, top, width, height, nbbuttons, view, plusminus)

Property Summary
Field Attributes	Field Name and Description
	currentImage The image for the button showing the current zoom level.
	downImage The image for zooming in when the tool is vertical.
	leftImage The image for zooming out when the tool is horizontal.
	minusImage The image for the minus button.
	plusImage The image for the plus button.
	rightImage The image for zooming in when the tool is horizontal.
	rolloverCurrentImage The rollover image for the button showing the current zoom level.
	rolloverDownImage The rollover image for zooming in when the tool is vertical.
	rolloverLeftImage The rollover image for zooming out when the tool is horizontal
	rolloverMinusImage The rollover image for the minus button.
	rolloverPlusImage The rollover image for the plus button.
	rolloverRightImage The rollover image for zooming in when the tool is horizontal.
	rolloverUpImage The rollover image for zooming out when the tool is vertical.
	upImage The image for zooming out when the tool is vertical.

Method Summary
Method Attributes	Method Name and Description
	getMessagePanel() Returns the message panel where the messages will be displayed.
	getOrientation() Returns the orientation of the tool.
	getView() Returns the main view associated with this component.
	setMessagePanel(ilvHTMLPanel) Sets the message panel where the message will be displayed.
	setOrientation(orientation) Sets the orientation of the tool.

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

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

Constructor Detail

IlvZoomTool

IlvZoomTool(left, top, width, height, nbbuttons, view, plusminus)

Parameters:: left - The x absolute position on the page.; top - The y absolute position on the page.; width - The width of the component.; height - The height of the component.; nbbuttons - The number of buttons.; view - The IlvView.; plusminus - Whether displaying a '+' and '-' to go the next or previous zoom level.

Property Detail

currentImage

currentImage

The image for the button showing the current zoom level.

downImage

downImage

The image for zooming in when the tool is vertical.

leftImage

leftImage

The image for zooming out when the tool is horizontal.

minusImage

minusImage

The image for the minus button.

plusImage

plusImage

The image for the plus button.

rightImage

rightImage

The image for zooming in when the tool is horizontal.

rolloverCurrentImage

rolloverCurrentImage

The rollover image for the button showing the current zoom level.

rolloverDownImage

rolloverDownImage

The rollover image for zooming in when the tool is vertical.

rolloverLeftImage

rolloverLeftImage

The rollover image for zooming out when the tool is horizontal

rolloverMinusImage

rolloverMinusImage

The rollover image for the minus button.

rolloverPlusImage

rolloverPlusImage

The rollover image for the plus button.

rolloverRightImage

rolloverRightImage

The rollover image for zooming in when the tool is horizontal.

rolloverUpImage

rolloverUpImage

The rollover image for zooming out when the tool is vertical.

upImage

upImage

The image for zooming out when the tool is vertical.

Method Detail

getMessagePanel

getMessagePanel()

Returns the message panel where the messages will be displayed.

Returns:: An instance of IlvHTMLPanel or null.

getOrientation

getOrientation()

Returns the orientation of the tool.

getView

getView()

Returns the main view associated with this component.

setMessagePanel

setMessagePanel(ilvHTMLPanel)

Sets the message panel where the message will be displayed.

Parameters:: ilvHTMLPanel - An instance of IlvHTMLPanel.

setOrientation

setOrientation(orientation)

Sets the orientation of the tool.

Parameters:: orientation - The orientation, which can be 'Vertical' or 'Horizontal'.