public class IlvFacesView extends IlvBasicView implements IlvFrameworkConstants
This view has two main modes: regular or tiled mode.
tileSize
property value. If this size is greater than 0, the view
is in tiled mode, or in regular mode otherwise.Modifier and Type | Field and Description |
---|---|
static Double |
MAX_ZOOM_DEFAULT_VALUE
The maximum zoom level.
|
static Double |
MIN_ZOOM_DEFAULT_VALUE
The minimum zoom level.
|
static Double |
PAN_FACTOR_DEFAULT_VALUE
The factor used when pan JavaScript actions are called (like
panNorth , and so on) |
static Double |
ZOOM_FACTOR_DEFAULT_VALUE
The factor used when
zoomIn or zoomOut JavaScript actions are called. |
DEFAULT_OBJECT_FINDER
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
AUTO_REFRESH, BOUNDING_BOX, COLOR, CONSTRAINED_ON_CONTENTS, GROUPABLE, HITMAP_LAYERS, IGNORE_CONTENT_ASPECT_RATIO, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, OPACITY, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TEMPLATE, TILE_SIZE, TOLERANCE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS
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 and Description |
---|
IlvFacesView()
Creates a new
IlvFacesView instance. |
Modifier and Type | Method and Description |
---|---|
IlvRect |
getBoundingBox()
Returns the bounding box of the displayed view in manager coordinate system.
|
IlvObjectSelectedFinder |
getDefaultObjectFinder()
Returns the default finder of this view.
|
String |
getHitmapLayers()
Returns the hitmap layers of this view.
|
String |
getHotkeys()
Returns the hotkeys for this view.
|
IlvFacesInteractor |
getInteractor()
Returns the interactor currently set on this view.
|
String |
getInteractorId()
Returns the interactor identifier currently set on this view.
|
double |
getMaxZoomLevel()
Returns the maximum zoom level of the view when the zoom is free.
|
double |
getMinZoomLevel()
Returns the minimum zoom level of the view when the zoom is free.
|
double |
getPanFactor()
Returns the pan factor used in the client built-in pan actions.
|
int |
getScrollBar()
Gets the scroll bar state of the view.
|
int |
getStaticLayersCount()
Returns the number of static layers.
|
int |
getTileSize()
Returns the tile size.
|
IlvManagerView |
getView()
Returns the manager view that will be displayed by the view.
|
ArrayList<String> |
getVisibleLayers()
Returns the visible manager layer names.
|
double |
getZoomFactor()
Returns the zoom factor used during client
zoomIn and zoomOut actions. |
double[] |
getZoomLevels()
Returns the fixed zoom levels displayed by the view.
|
boolean |
isConstrainedOnContents()
Returns whether the view is constrained to the manager content bounds or not.
|
boolean |
isProgressiveZoom()
Checks whether the view is progressive zoom or not.
|
void |
processValidators(javax.faces.context.FacesContext context) |
void |
restoreState(javax.faces.context.FacesContext context,
Object stateObj)
Restores the state of this component from the
stateObj parameter. |
Object |
saveState(javax.faces.context.FacesContext context)
Returns the state of this component.
|
void |
setBoundingBox(IlvRect boundingBox)
Sets the view bounding box.
|
void |
setConstrainedOnContents(boolean constrainedOnContents)
Defines whether the view is constrained to the manager content bounds or not.
|
void |
setHitmapLayers(String hitmapLayers)
Sets the hitmap layers for this view.
|
void |
setHotkeys(String hotkeys)
Sets the hotkeys for this view.
|
void |
setInteractor(IlvFacesInteractor interactor)
The interactor property.
|
void |
setInteractorId(String interactorId)
The interactor identifier property.
|
void |
setMaxZoomLevel(double maxZoomLevel)
Sets the maximum zoom level.
|
void |
setMinZoomLevel(double minZoomLevel)
Sets the minimum zoom level.
|
void |
setPanFactor(double panFactor)
The factor used in the client built-in pan actions.
|
void |
setProgressiveZoom(boolean progressiveZoom)
Sets progressive zoom.
|
void |
setScrollBar(int scrollBar)
Sets the scroll bar state of the view.
|
void |
setStaticLayersCount(int layersCount)
Sets the number of static layers.
|
void |
setTileSize(int tileSize)
Sets the size of a tile.
|
void |
setView(IlvManagerView view)
Sets the manager view that will be displayed by the view.
|
void |
setVisibleLayers(ArrayList<String> visibleLayers)
Sets the visible manager layer names.
|
void |
setZoomFactor(double zoomFactor)
Sets the factor used when
zoomIn or zoomOut JavaScript actions are called. |
void |
setZoomLevels(double[] zoomLevels)
Sets the fixed zoom levels displayed by the view.
|
void |
updateModel(javax.faces.context.FacesContext context)
This method updates the referenced values with the local values of the
component if these values were updated from the client.
|
clearDecodedPropertyMap, createFacesComponent, getAttributes, getBaseTextDirection, getComponentType, getData, getFamily, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setBaseTextDirection, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidth
getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValue, setValueBinding, setValueExpression
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree
public static final Double ZOOM_FACTOR_DEFAULT_VALUE
zoomIn
or zoomOut
JavaScript actions are called.public static final Double PAN_FACTOR_DEFAULT_VALUE
panNorth
, and so on)public static final Double MAX_ZOOM_DEFAULT_VALUE
zoomLevels
property is not used. The default value is 10.
public static final Double MIN_ZOOM_DEFAULT_VALUE
zoomLevels
property is not used. The default value is 1 (fit to content).
public IlvFacesInteractor getInteractor()
public void setInteractor(IlvFacesInteractor interactor)
interactor
- The interactor to set.public String getInteractorId()
public void setInteractorId(String interactorId)
interactorId
- The interactor ID to set.public double getZoomFactor()
zoomIn
and zoomOut
actions.
The zoom is limited by the maxZoomLevel
property.
This factor is used, if and only if, the zoom is free, for example, if the zoomLevel
property is not set.
public void setZoomFactor(double zoomFactor)
zoomIn
or zoomOut
JavaScript actions are called.
This factor is used, if and only if, the zoom levels are free, for example, if the zoomLevel
property is not set.
zoomFactor
- The zoom factor to set.public double getPanFactor()
public void setPanFactor(double panFactor)
panFactor
- The panFactor
to set.public IlvRect getBoundingBox()
If this property is bound to a String bean property,
this value is converted, if possible, in a valid
IlvRect
instance.
public void setBoundingBox(IlvRect boundingBox)
Note that the view may adapt this bounding box according to some constraints, such as fixed zoom levels.
boundingBox
- The bounding box in the manager coordinate system.public void setView(IlvManagerView view)
view
- The manager view to be displayed.public IlvManagerView getView() throws Exception
Exception
public double[] getZoomLevels()
If the zoom levels are not specified, the zoom is only bound by the maxZoomLevel
property.
public void setZoomLevels(double[] zoomLevels)
If the zoom levels are not specified, the zoom is only bound by the maxZoomLevel
property.
zoomLevels
- The zoom levels to set.public double getMaxZoomLevel()
This property is used if, and only if, the zoomLevels
property is not used.
The default value is 10.
public void setMaxZoomLevel(double maxZoomLevel)
This property is used if, and only if, the zoomLevels
property is not used.
The default value is 10.
maxZoomLevel
- The max zoom level to set.public double getMinZoomLevel()
This property is used if, and only if, the zoomLevels
property is not used.
The default value is 1.
public void setMinZoomLevel(double minZoomLevel)
This property is used if, and only if, the zoomLevels
property is not used.
The default value is 1.
minZoomLevel
- The min zoom level to set.public int getTileSize()
By default the tile size is -1, which means that tiled mode is disabled.
public void setTileSize(int tileSize)
The tile size must be carefully chosen for performance reasons.
See the dedicated section of the user manual for more information.
tileSize
- The tile size to set.getTileSize()
public int getStaticLayersCount()
public void setStaticLayersCount(int layersCount)
layersCount
- The number of static layers.getStaticLayersCount()
public void setVisibleLayers(ArrayList<String> visibleLayers)
This property controls the manager layers that are visible. If the view is in tiled mode, manipulating only dynamic layer visibility is mandatory. Static layers are meant to be cached and must not be updated.
visibleLayers
- The visible layer name list to set.public ArrayList<String> getVisibleLayers()
This property controls the manager layers that are visible. If the view is in tiled mode, manipulating only dynamic layer visibilty is mandatory. Static layers are meant to be cached and must not be updated.
public boolean isConstrainedOnContents()
true
.
Note that zoom levels (set by minZoomLevel
or zoomLevels
) lower than 1 will not be allowed if this property is set to true
.
public void setConstrainedOnContents(boolean constrainedOnContents)
true
.
Note that zoom levels (set by minZoomLevel
or zoomLevels
) lower than 1 will not be allowed if this property is set to true
.
constrainedOnContents
- Defines whether the view is constrained or not.public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class javax.faces.component.UIComponentBase
public IlvObjectSelectedFinder getDefaultObjectFinder()
getDefaultObjectFinder
in class IlvBasicView
null
.public void updateModel(javax.faces.context.FacesContext context)
updateModel
in class IlvBasicView
context
- The current faces context.public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface IlvFacesComponent
saveState
in interface javax.faces.component.StateHolder
saveState
in class IlvBasicView
context
- The current faces context.state
of this component.public void restoreState(javax.faces.context.FacesContext context, Object stateObj)
stateObj
parameter.restoreState
in interface IlvFacesComponent
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class IlvBasicView
context
- The current faces context.stateObj
- The previously saved state of this component.public void setProgressiveZoom(boolean progressiveZoom)
progressiveZoom
- Whether progressive zoom is ued.public boolean isProgressiveZoom()
public void setScrollBar(int scrollBar)
scrollBar
- the scroll bar state will be set.public int getScrollBar()
public String getHitmapLayers()
public void setHitmapLayers(String hitmapLayers)
hitmapLayers
- The hitmapLayers to set.public String getHotkeys()
public void setHotkeys(String hotkeys)
hotkeys
- The hotkeys to set.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.