ilog.views.faces.component
Class IlvFacesZoomTool

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIGraphic
              ilog.views.faces.component.IlvBasicView
                  ilog.views.faces.component.IlvBasicViewHelper
                      ilog.views.faces.component.IlvFacesZoomTool

All Implemented Interfaces:

IlvFacesComponent, IlvViewHelper, IlvFacesConstants, IlvFrameworkConstants, Serializable, StateHolder

public class IlvFacesZoomTool
extends IlvBasicViewHelper
implements IlvFrameworkConstants

The zoom tool is a component that displays several buttons vertically or horizontally. Each button corresponds to a zoom level.

Since:

JViews 6.5

See Also:

Serialized Form

Field Summary

static Integer

NB_BUTTONS_DEFAULT_VALUE Default value of nbButtons property.

Fields inherited from class ilog.views.faces.component.IlvBasicView

DEFAULT_OBJECT_FINDER

Fields inherited from class javax.faces.component.UIGraphic

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from interface ilog.views.faces.IlvFrameworkConstants

ACTION_NAME, AUTO_REFRESH, BOUNDING_BOX, CONSTRAINED_ON_CONTENTS, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TILE_SIZE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS

Fields inherited from interface ilog.views.faces.IlvFacesConstants

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_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, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

IlvFacesZoomTool()
Creates a new IlvFacesZoomTool instance.

Method Summary

static String	getComponentType() Returns the type of this component.
String	getFamily() Returns the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. This implementation returns the fully qualified class name.
int	getNbButtons() Returns the number of buttons to be displayed in the zoom tool.
String	getOrientation() Returns the orientation of the zoom tool.
void	restoreState(FacesContext context, Object stateObj) Restores the state of this component from the stateObj parameter.
Object	saveState(FacesContext context) Returns the state of this component.
void	setNbButtons(int nbButtons) Sets the number of buttons to be displayed in the zoom tool.
void	setOrientation(String orientation) The orientation of the zoom tool.
void	updateModel(FacesContext context) This method updates the referenced values with the local values of the component if these values were updated from the client.

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

createViewHelper, getView, getViewId, setView, setViewId

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

clearDecodedPropertyMap, createFacesComponent, getAttributes, getData, getDefaultObjectFinder, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidth

Methods inherited from class javax.faces.component.UIGraphic

getUrl, getValue, getValueBinding, setUrl, setValue, setValueBinding

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class java.lang.Object

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

Field Detail

NB_BUTTONS_DEFAULT_VALUE

public static final Integer NB_BUTTONS_DEFAULT_VALUE

Default value of nbButtons property.

Constructor Detail

IlvFacesZoomTool

public IlvFacesZoomTool()

Creates a new IlvFacesZoomTool instance.

Method Detail

getFamily

public String getFamily()

Returns the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.

This implementation returns the fully qualified class name.

Overrides:

getFamily in class IlvBasicViewHelper

Returns:

The family to which this component belongs.

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

getNbButtons

public int getNbButtons()

Returns the number of buttons to be displayed in the zoom tool.

Returns:

The number of buttons to display.

setNbButtons

public void setNbButtons(int nbButtons)

Sets the number of buttons to be displayed in the zoom tool.

Parameters:

nbButtons - The number of buttons to set.

getOrientation

public String getOrientation()

Returns the orientation of the zoom tool.
Possible values are IlvFrameworkConstants.ORIENTATION_VERTICAL or IlvFrameworkConstants.ORIENTATION_HORIZONTAL.

Returns:

The orientation.

setOrientation

public void setOrientation(String orientation)

The orientation of the zoom tool.
Possible values are IlvFrameworkConstants.ORIENTATION_VERTICAL or IlvFrameworkConstants.ORIENTATION_HORIZONTAL.

Parameters:

orientation - The orientation to set.

updateModel

public void updateModel(FacesContext context)

This method updates the referenced values with the local values of the component if these values were updated from the client.

Specified by:

updateModel in interface IlvViewHelper

Overrides:

updateModel in class IlvBasicViewHelper

Parameters:

context - The current faces context.

saveState

public Object saveState(FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface IlvViewHelper

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class IlvBasicViewHelper

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(FacesContext context,
                         Object stateObj)

Restores the state of this component from the stateObj parameter.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface IlvViewHelper

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class IlvBasicViewHelper

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.