ilog.views.faces.dhtml.component

Class IlvFacesDHTMLOverview

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIGraphic

ilog.views.faces.component.IlvBasicView

ilog.views.faces.component.IlvBasicViewHelper

ilog.views.faces.dhtml.component.IlvFacesDHTMLOverview

All Implemented Interfaces:

IlvFacesComponent, IlvViewHelper, IlvDHTMLConstants, IlvDHTMLFrameworkConstants, IlvFacesConstants, IlvFrameworkConstants, 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 IlvFacesDHTMLOverview
extends IlvBasicViewHelper
implements IlvDHTMLFrameworkConstants

This class defines an overview component that must be linked to a view through the view or viewId property. This component shows the whole view and a rectangle that represents the current bounding box of the linked view.

Since:

JViews 6.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Boolean	IGNORE_CONTENT_DEFAULT_VALUE Default value of ignore content aspect ratio property.
static Boolean	RESIZABLE_DEFAULT_VALUE Default value of resizable property.

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

DEFAULT_OBJECT_FINDER

Fields inherited from class jakarta.faces.component.UIGraphic

COMPONENT_FAMILY, COMPONENT_TYPE

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.dhtml.IlvDHTMLFrameworkConstants

SESSION_ID_PREFIX, STATE_URL, STATIC_LAYERS_COUNT_PARAM, TILE_MANAGER, UPDATE_INTERVAL

Fields inherited from interface ilog.views.faces.IlvFrameworkConstants

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

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLConstants

ACCESSIBLE, ACTION_NAME, AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, HOTKEYS, IMAGE_FORMAT, IMAGE_LOADED_HANDLER, IMAGE_MAP_GENERATOR, IMAGE_MAP_GENERATOR_CLASS, IMAGE_MAP_VISIBLE, IMAGE_SERVLET_CONTEXT, INVOCATION_CONTEXT, JSF_CONTEXT, ON_CLICK, ON_SELECTION_CHANGED, PARTIAL_SUBMIT, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SELECTION_RESIZABLE_CLASS, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE

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
IlvFacesDHTMLOverview() Creates a new IlvFacesDHTMLOverview instance.

Method Summary

Modifier and Type	Method and Description
Boolean	getAutoRefresh() Returns the refresh mode of the overview.
static String	getComponentType() Returns the type of this component.
String	getFamily() Returns the identifier of the component family to which this component belongs.
boolean	isIgnoreContentAspectRatio() Returns whether the view is ignore content aspect ratio or not.
boolean	isResizable() Returns whether the view is resizable or not.
void	restoreState(jakarta.faces.context.FacesContext context, Object stateObj) Restores the state of this component from the stateObj parameter.
Object	saveState(jakarta.faces.context.FacesContext context) Returns the state of this component.
void	setAutoRefresh(Boolean autoRefresh) Sets the refresh mode of the overview.
void	setIgnoreContentAspectRatio(boolean ignoreContentAspectRatio) Sets whether the view is ignore content aspect ratio or not.
void	setResizable(boolean resizable) Sets whether the view is resizable or not.
void	updateModel(jakarta.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.

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, getBaseTextDirection, getData, getDefaultObjectFinder, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setBaseTextDirection, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidth

Methods inherited from class jakarta.faces.component.UIGraphic

getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValue, setValueBinding, setValueExpression

Methods inherited from class jakarta.faces.component.UIComponentBase

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, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Field Detail

RESIZABLE_DEFAULT_VALUE

public static final Boolean RESIZABLE_DEFAULT_VALUE

Default value of resizable property.

IGNORE_CONTENT_DEFAULT_VALUE

public static final Boolean IGNORE_CONTENT_DEFAULT_VALUE

Default value of ignore content aspect ratio property.

Since:

JViews 8.8

Constructor Detail

IlvFacesDHTMLOverview

public IlvFacesDHTMLOverview()

Creates a new IlvFacesDHTMLOverview 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.

getAutoRefresh

public Boolean getAutoRefresh()

Returns the refresh mode of the overview.

Returns:

true if the refresh mode is set.

setAutoRefresh

public void setAutoRefresh(Boolean autoRefresh)

Sets the refresh mode of the overview. If set to true the overview will be reloaded each time it changes.

Parameters:

autoRefresh - The auto refresh mode to set.

isResizable

public boolean isResizable()

Returns whether the view is resizable or not.

Returns:

The resizable flag.

setResizable

public void setResizable(boolean resizable)

Sets whether the view is resizable or not.

Parameters:

resizable - The resizable flag.

isIgnoreContentAspectRatio

public boolean isIgnoreContentAspectRatio()

Returns whether the view is ignore content aspect ratio or not.

Returns:

The ignore content aspect ratio flag.

Since:

JViews 8.8

setIgnoreContentAspectRatio

public void setIgnoreContentAspectRatio(boolean ignoreContentAspectRatio)

Sets whether the view is ignore content aspect ratio or not.

Parameters:

ignoreContentAspectRatio - The ignore content aspect ratio flag.

Since:

JViews 8.8

updateModel

public void updateModel(jakarta.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.

Specified by:

updateModel in interface IlvViewHelper

Overrides:

updateModel in class IlvBasicViewHelper

Parameters:

context - The current faces context.

saveState

public Object saveState(jakarta.faces.context.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 jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvBasicViewHelper

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(jakarta.faces.context.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 jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvBasicViewHelper

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.