ilog.views.maps.faces.component

Class IlvFacesLayerVisibilityTool

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

ilog.views.faces.component.IlvFacesComponentBase

ilog.views.maps.faces.component.IlvFacesLayerVisibilityTool

All Implemented Interfaces:

IlvFacesComponent, IlvViewHelper, IlvFacesConstants, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, Serializable, EventListener

public class IlvFacesLayerVisibilityTool
extends IlvFacesComponentBase
implements IlvViewHelper

The layer tool is a display tool that allows the user to change the visible layers.

Since:

JViews 8.0

See Also:

Serialized Form

Field Summary

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface ilog.views.faces.IlvFacesConstants

AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvFacesLayerVisibilityTool() Creates a new IlvFacesLayerVisibilityTool instance.

Method Summary

Modifier and Type	Method and Description
protected IlvViewHelper	createViewHelper() Creates the default IlvViewHelper used by this component.
String	getBaseTextDirection() Returns the base direction of the element.
static String	getComponentType() Returns the type of this component.
String	getEnabled() Returns the enabled inline client of this component.
String	getFamily() Returns the family of this component.
String	getMessage() Returns the inline client message of this component.
IlvMessageBox	getMessageBox() Returns the message box.
String	getMessageBoxId() Returns the message box identifier.
String	getStyle() Returns the inline client style of this component.
String	getStyleClass() Returns the client CSS class(es) of this component.
String	getTitle() Returns the inline client title of this component.
IlvBasicView	getView() Returns the view component associated with this component.
String	getViewId() Returns the ID of the view linked to this component.
void	restoreState(jakarta.faces.context.FacesContext context, Object stateObj) Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(jakarta.faces.context.FacesContext context) Gets the state of the instance as a Serializable Object.
void	setBaseTextDirection(String baseTextDirection) Changes the base direction of the element.
void	setEnabled(String enabled) Sets the inline client to enabled.
void	setMessage(String message) Sets the inline client message.
void	setMessageBox(IlvMessageBox messageBox) The message box property.
void	setMessageBoxId(String messageBoxId) The message box identifier property.
void	setStyle(String style) Sets the inline client style.
void	setStyleClass(String styleClass) Sets the client CSS class(es).
void	setTitle(String title) Sets the inline client title.
void	setView(IlvBasicView view) Sets the view component associated with this component.
void	setViewId(String viewId) Sets the ID of the view linked to this component.
void	updateModel(jakarta.faces.context.FacesContext context) Handles the "Update Model Values" phase of the JSF life cycle.

Methods inherited from class ilog.views.faces.component.IlvFacesComponentBase

clearDecodedPropertyMap, createFacesComponent, getAttributes, getClientId, isDecodedProperty, processUpdates, resetDecodedProperties, setDecodedProperty

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvFacesLayerVisibilityTool

public IlvFacesLayerVisibilityTool()

Creates a new IlvFacesLayerVisibilityTool instance.

Method Detail

getFamily

public String getFamily()

Returns the family of this component.

Specified by:

getFamily in class jakarta.faces.component.UIComponent

Returns:

The family of this component.

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

createViewHelper

protected IlvViewHelper createViewHelper()

Creates the default IlvViewHelper used by this component. This default implementation returns an IlvViewHelperImpl

Returns:

The default IlvViewHelper implementation.

getView

public IlvBasicView getView()

Returns the view component associated with this component.

Specified by:

getView in interface IlvViewHelper

Returns:

The view component associated with this component.

getViewId

public String getViewId()

Returns the ID of the view linked to this component.

Specified by:

getViewId in interface IlvViewHelper

Returns:

The ID of the view linked to this component.

setView

public void setView(IlvBasicView view)

Sets the view component associated with this component.

Specified by:

setView in interface IlvViewHelper

Parameters:

view - The view component associated with this component.

getMessageBox

public IlvMessageBox getMessageBox()

Returns the message box.

Returns:

The message box.

setMessageBox

public void setMessageBox(IlvMessageBox messageBox)

The message box property.

Parameters:

messageBox - The message box to set.

getMessageBoxId

public String getMessageBoxId()

Returns the message box identifier.

Returns:

The message box ID.

setMessageBoxId

public void setMessageBoxId(String messageBoxId)

The message box identifier property.

Parameters:

messageBoxId - The message box ID to set.

setViewId

public void setViewId(String viewId)

Sets the ID of the view linked to this component.

Specified by:

setViewId in interface IlvViewHelper

Parameters:

viewId - The ID of the view linked to this component.

getStyle

public String getStyle()

Returns the inline client style of this component.

Returns:

The inline client style of this component.

setEnabled

public void setEnabled(String enabled)

Sets the inline client to enabled.

Parameters:

enabled - The enabled inline client.

getEnabled

public String getEnabled()

Returns the enabled inline client of this component.

Returns:

The enabled inline client of this component.

setTitle

public void setTitle(String title)

Sets the inline client title.

Parameters:

title - The inline client title.

getTitle

public String getTitle()

Returns the inline client title of this component.

Returns:

The inline client title of this component.

getMessage

public String getMessage()

Returns the inline client message of this component.

Returns:

The inline client message of this component.

setMessage

public void setMessage(String message)

Sets the inline client message.

Parameters:

message - The inline client message.

setStyle

public void setStyle(String style)

Sets the inline client style.

Parameters:

style - The inline client style.

getStyleClass

public String getStyleClass()

Returns the client CSS class(es) of this component.

Returns:

The client CSS class(es) of this component.

setStyleClass

public void setStyleClass(String styleClass)

Sets the client CSS class(es).

Parameters:

styleClass - The client CSS class(es).

getBaseTextDirection

public String getBaseTextDirection()

Returns the base direction of the element.

Returns:

One of the following values:

• IlvBidiUtil.INHERITED_DIRECTION: base text direction is inherited
• IlvBidiUtil.COMPONENT_DIRECTION: default GUI base text direction
• IlvBidiUtil.LEFT_TO_RIGHT: left-to-right base text direction.
• IlvBidiUtil.RIGHT_TO_LEFT: right-to-left base text direction.
• IlvBidiUtil.CONTEXTUAL_DIRECTION: contextual base text direction.

Since:

JViews 8.8

setBaseTextDirection

public void setBaseTextDirection(String baseTextDirection)

Changes the base direction of the element.

Parameters:

baseTextDirection - One of the following values:

• IlvBidiUtil.INHERITED_DIRECTION: base text direction is inherited
• IlvBidiUtil.COMPONENT_DIRECTION: default GUI base text direction
• IlvBidiUtil.LEFT_TO_RIGHT: left-to-right base text direction.
• IlvBidiUtil.RIGHT_TO_LEFT: right-to-left base text direction.
• IlvBidiUtil.CONTEXTUAL_DIRECTION: contextual base text direction.

Since:

JViews 8.8

updateModel

public void updateModel(jakarta.faces.context.FacesContext context)

Handles the "Update Model Values" phase of the JSF life cycle. This method updates the referenced values with the local values of the component if theses values were updated during the "Apply Request Values" phase.

Specified by:

updateModel in interface IlvViewHelper

Overrides:

updateModel in class IlvFacesComponentBase

Parameters:

context - The current faces context.

saveState

public Object saveState(jakarta.faces.context.FacesContext context)

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.saveState(jakarta.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets.

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface IlvViewHelper

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvFacesComponentBase

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(jakarta.faces.context.FacesContext context,
                         Object stateObj)

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.restoreState(jakarta.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface IlvViewHelper

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvFacesComponentBase

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.