Rogue Wave JViews Maps JavaScript Reference: Class IlvFacesLayerVisibilityTool

Class IlvFacesLayerVisibilityTool

IlvObject
   |
   +--IlvFacesLayerVisibilityTool

Category:: Maps JSF component

JavaScript File:: IlvFacesLayerVisibilityTool.js

Description:: IlvFacesLayerVisibilityTool is a component that displays layers and gives control on their visibility.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvFacesLayerVisibilityTool(selfId, parentId)

Method Summary
Method Attributes	Method Name and Description
	addLayer(layerName, layerIndex) Internal implementation Adds a single layer on the layer table.
	createLayers() Internal implementation Fills the layer table.
	getAbsoluteId() Returns the absolute identifier of the server side JavaServer Faces component.
	getView() Returns the dependency view of this component.
	mouseOver(e) This method is invoked when the mouse is over the layer table.
	setAbsoluteId(absId) Sets the absolute identifier of the server side JavaServer Faces component.
	setEnabled(enabled) Enables or disables layer visibility control .
	setLayerEnabled(layerIndex, enabled) Enables the visible/invisible toggle for a single layer on the layer table.
	setMessage(message) Sets the message to be displayed when the mouse is over the button.
	setMessageBox(panelProxy) Sets the message box of the view.
	setStyle(style) Changes the style of the table and its cells.
	setStyleClass(style) Changes the style of the table and its cells.
	setTitle(title) Sets the component title and tooltip.
	setView(viewProxy) Sets the dependency view of this component
	toggleLayer(k, bool) Internal implementation Invoked when clicking on a layer toggle.
	updateLayers() Internal implementation Updates the layer state.

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

Constructor Detail

IlvFacesLayerVisibilityTool

IlvFacesLayerVisibilityTool(selfId, parentId)

Parameters:: selfId - Id of the component; parentId - Id of the parent span intended to contain the layer table.

Method Detail

addLayer

addLayer(layerName, layerIndex)

Internal implementation
Adds a single layer on the layer table.

Parameters:: layerName; layerIndex

createLayers

createLayers()

Internal implementation
Fills the layer table. This is an on-load handler.

getAbsoluteId

getAbsoluteId()

Returns the absolute identifier of the server side JavaServer Faces component. This identifier must be returned to update component properties that reference other components.

Returns:: The absolute identifier of the component.

getView

getView()

Returns the dependency view of this component.

Returns:: The view to link to.

mouseOver

mouseOver(e)

This method is invoked when the mouse is over the layer table.

Parameters:: e

setAbsoluteId

setAbsoluteId(absId)

Sets the absolute identifier of the server side JavaServer Faces component.

Parameters:: absId - The absolute identifier of the component.

setEnabled

setEnabled(enabled)

Enables or disables layer visibility control .

Parameters:: enabled - true or false.

setLayerEnabled

setLayerEnabled(layerIndex, enabled)

Enables the visible/invisible toggle for a single layer on the layer table.

Parameters:: layerIndex - Index of the layer.; enabled - Layer desired visibility.

Since:: JViews 8.5

setMessage

setMessage(message)

Sets the message to be displayed when the mouse is over the button. The message is displayed in the status window of the browser and in the panel set using the setMessagePanel method.

Parameters:: message - The message.

setMessageBox

setMessageBox(panelProxy)

Sets the message box of the view. The messages of this view will be displayed in this message box.

Parameters:: panelProxy - The message box.

setStyle

setStyle(style)

Changes the style of the table and its cells.

Parameters:: style - A String containing CSS text.

setStyleClass

setStyleClass(style)

Changes the style of the table and its cells.

Parameters:: style - A String containing the name of a CSS style.

setTitle

setTitle(title)

Sets the component title and tooltip.

Parameters:: title - the component title.

setView

setView(viewProxy)

Sets the dependency view of this component

Parameters:: viewProxy - The view to link this component to.

toggleLayer

toggleLayer(k, bool)

Internal implementation
Invoked when clicking on a layer toggle.

Parameters:: k; bool

updateLayers

updateLayers()

Internal implementation
Updates the layer state. This is an on-load handler.