Rogue Wave JViews Framework JavaScript Reference: Class IlvLegend

Class IlvLegend

IlvObject
   |
   +--IlvEmptyView
      |
      +--IlvLegend

Category:: Graphics Framework component

JavaScript File:: IlvLegend.js

Description:: IlvLegend is a component that displays the list of layers that are available on the server and lets you turn the visibility of each layer on or off.

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

Method Summary
Method Attributes	Method Name and Description
	getBackgroundColor() Returns the background color.
	getFontSize() Returns the font size of the text.
	getTextColor() Returns the color of the text.
	getTitle() Returns the title of the legend.
	getTitleBackgroundColor() Returns the background color of the title.
	getTitleFontSize() Returns the font size of the title text.
	getTitleForegroundColor() Returns the foreground color of the title.
	getView() Returns the view associated with this legend.
	setBackgroundColor(color) Changes the background color.
	setFontSize(size) Changes the font size of the text.
	setTextColor(color) Changes the color of the text.
	setTitle(title) Changes the title of the legend.
	setTitleBackgroundColor(color) Changes the background color of the title.
	setTitleFontSize(size) Changes the font size of the title text.
	setTitleForegroundColor(color) Changes the foreground color of the title.

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

IlvLegend

IlvLegend(left, top, width, height, view)

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.; view - The IlvView.

Method Detail

getBackgroundColor

getBackgroundColor()

Returns the background color.

getFontSize

getFontSize()

Returns the font size of the text.

getTextColor

getTextColor()

Returns the color of the text.

getTitle

getTitle()

Returns the title of the legend.

getTitleBackgroundColor

getTitleBackgroundColor()

Returns the background color of the title.

getTitleFontSize

getTitleFontSize()

Returns the font size of the title text.

getTitleForegroundColor

getTitleForegroundColor()

Returns the foreground color of the title.

getView

getView()

Returns the view associated with this legend.

setBackgroundColor

setBackgroundColor(color)

Changes the background color.

Parameters:: color - The color.

setFontSize

setFontSize(size)

Changes the font size of the text.

Parameters:: size - The font size to set.

setTextColor

setTextColor(color)

Changes the color of the text.

Parameters:: color - The color.

setTitle

setTitle(title)

Changes the title of the legend.

Parameters:: title - A string.

setTitleBackgroundColor

setTitleBackgroundColor(color)

Changes the background color of the title.

Parameters:: color - The color.

setTitleFontSize

setTitleFontSize(size)

Changes the font size of the title text.

Parameters:: size - The font size of the title text to set.

setTitleForegroundColor

setTitleForegroundColor(color)

Changes the foreground color of the title.

Parameters:: color - The color.