ilog.views.chart.faces.dhtml.component

Class IlvChartDHTMLLegend

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIGraphic

ilog.views.faces.component.IlvBasicView

ilog.views.chart.faces.component.IlvChartView

ilog.views.chart.faces.dhtml.component.IlvChartDHTMLViewComponent

ilog.views.chart.faces.dhtml.component.IlvChartDHTMLLegend

All Implemented Interfaces:

IlvChartConstants, IlvFacesComponent, IlvViewHelper, IlvDHTMLHelper, IlvDHTMLConstants, 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 IlvChartDHTMLLegend
extends IlvChartDHTMLViewComponent
implements IlvViewHelper

This class defines a JViews Faces DHTML legend component. This component must be linked to a chart view component.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.faces.dhtml.component.IlvChartDHTMLViewComponent

ACCESSIBLE_DEFAULT_VALUE, RESIZABLE_DEFAULT_VALUE

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

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.chart.faces.IlvChartConstants

AUTO_REFRESH, CHART, DATA_SOURCE, DATA_SOURCE_ID, DATABASE_DRIVER, DATABASE_PASSWORD, DATABASE_QUERY, DATABASE_RESULT_SET, DATABASE_URL, DATABASE_USER, FILENAME, INTERACTOR, INTERACTOR_ID, ITEM_PICKING, KEEP_VISIBLE_WINDOW, LABEL_COLUMN_MAPPING, LAYOUT, LEGEND_LAYOUT, MESSAGEBOX, NEAREST_ITEM_PICKING, NEAREST_POINT_PICKING, OVERVIEW_ACTION_NAME, PAN_ACTION_NAME, PICKING_MODE, REFRESH_DATA, SESSION_ID_PREFIX, STATE_URL, STYLE_SHEET, STYLE_SHEETS, TYPE, UPDATE_INTERVAL, X_COLUMN_MAPPING, X_PAN_ALLOWED, X_ZOOM_ALLOWED, X_ZOOM_FACTOR, Y_COLUMN_MAPPING, Y_PAN_ALLOWED, Y_ZOOM_ALLOWED, Y_ZOOM_FACTOR, ZOOM_ACTION_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected IlvViewHelper	createViewHelper() Creates the view helper used by this legend.
static String	getComponentType() Returns the type of this component.
String	getFamily() Returns the identifier of the component family to which this component belongs.
String	getLayout() Retrieves the layout direction of this legend.
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) Restores the state of this component from the stateObj parameter.
Object	saveState(jakarta.faces.context.FacesContext context) Returns the state of this component.
void	setLayout(String layout) Sets the layout direction for the legend.
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 ctx) 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.chart.faces.dhtml.component.IlvChartDHTMLViewComponent

createDHTMLHelper, getBackgroundColor, getErrorMessage, getHotkeys, getImageFormat, getImageMapGenerator, getImageMapGeneratorClass, getOnCapabilitiesLoaded, getOnImageLoaded, getServlet, getServletClass, getServletURL, getWaitingImage, isAccessible, isGenerateImageMap, isImageMapVisible, isResizable, setAccessible, setBackgroundColor, setErrorMessage, setGenerateImageMap, setHotkeys, setImageFormat, setImageMapGenerator, setImageMapGeneratorClass, setImageMapVisible, setOnCapabilitiesLoaded, setOnImageLoaded, setResizable, setServlet, setServletClass, setServletURL, setValue, setWaitingImage

Methods inherited from class ilog.views.chart.faces.component.IlvChartView

getClientState, getDataSource, getDataSourceId, getDefaultObjectFinder, getInteractor, getInteractorId, getProject, getType, getXZoomFactor, getYZoomFactor, setClientState, setDataSource, setDataSourceId, setInteractor, setInteractorId, setProject, setType, setXZoomFactor, setYZoomFactor

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

clearDecodedPropertyMap, createFacesComponent, getAttributes, getBaseTextDirection, getData, 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, 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

Constructor Detail

IlvChartDHTMLLegend

public IlvChartDHTMLLegend()

Creates a new IlvChartDHTMLLegend instance.

Method Detail

createViewHelper

protected IlvViewHelper createViewHelper()

Creates the view helper used by this legend. This default implementation creates an IlvViewHelperImpl.

Returns:

The default IlvViewHelper implementation.

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

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 IlvChartView

Returns:

The family to which this component belongs.

updateModel

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

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

Specified by:

updateModel in interface IlvDHTMLHelper

Overrides:

updateModel in class IlvChartDHTMLViewComponent

Parameters:

ctx - The current faces context.

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.

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.

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.

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.

setLayout

public void setLayout(String layout)

Sets the layout direction for the legend. Valid parameter values are "vertical" or "horizontal".

Parameters:

layout - The layout direction.

getLayout

public String getLayout()

Retrieves the layout direction of this legend.

Returns:

The layout direction of this legend.

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 IlvDHTMLHelper

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvChartDHTMLViewComponent

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 IlvDHTMLHelper

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvChartDHTMLViewComponent

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.