public class IlvFacesLayerVisibilityTool extends IlvFacesComponentBase implements IlvViewHelper
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
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 |
---|
IlvFacesLayerVisibilityTool()
Creates a new
IlvFacesLayerVisibilityTool instance. |
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(javax.faces.context.FacesContext context,
Object stateObj)
Perform any processing required to restore the state from the
entries in the state Object.
|
Object |
saveState(javax.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(javax.faces.context.FacesContext context)
Handles the "Update Model Values" phase of the JSF life cycle.
|
clearDecodedPropertyMap, createFacesComponent, getAttributes, getClientId, isDecodedProperty, processUpdates, resetDecodedProperties, setDecodedProperty
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
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
public IlvFacesLayerVisibilityTool()
IlvFacesLayerVisibilityTool
instance.public String getFamily()
getFamily
in class javax.faces.component.UIComponent
public static String getComponentType()
protected IlvViewHelper createViewHelper()
IlvViewHelper
used by this component.
This default implementation returns an IlvViewHelperImpl
IlvViewHelper
implementation.public IlvBasicView getView()
getView
in interface IlvViewHelper
public String getViewId()
getViewId
in interface IlvViewHelper
public void setView(IlvBasicView view)
setView
in interface IlvViewHelper
view
- The view component associated with this component.public IlvMessageBox getMessageBox()
public void setMessageBox(IlvMessageBox messageBox)
messageBox
- The message box to set.public String getMessageBoxId()
public void setMessageBoxId(String messageBoxId)
messageBoxId
- The message box ID to set.public void setViewId(String viewId)
setViewId
in interface IlvViewHelper
viewId
- The ID of the view linked to this component.public String getStyle()
style
of this component.style
of this component.public void setEnabled(String enabled)
enabled
.enabled
- The enabled
inline client.public String getEnabled()
enabled
inline client of this component.enabled
inline client of this component.public void setTitle(String title)
title
.title
- The inline client title
.public String getTitle()
title
of this component.title
of this component.public String getMessage()
message
of this component.message
of this component.public void setMessage(String message)
message
.message
- The inline client message
.public void setStyle(String style)
style
.style
- The inline client style
.public String getStyleClass()
public void setStyleClass(String styleClass)
styleClass
- The client CSS class(es).public String getBaseTextDirection()
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.
public void setBaseTextDirection(String baseTextDirection)
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.
public void updateModel(javax.faces.context.FacesContext context)
updateModel
in interface IlvViewHelper
updateModel
in class IlvFacesComponentBase
context
- The current faces context.public Object saveState(javax.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(javax.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
saveState
in interface IlvFacesComponent
saveState
in interface IlvViewHelper
saveState
in interface javax.faces.component.StateHolder
saveState
in class IlvFacesComponentBase
context
- The current faces context.public void restoreState(javax.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(javax.faces.context.FacesContext, java.lang.Object)
method on all those
instances as well.
restoreState
in interface IlvFacesComponent
restoreState
in interface IlvViewHelper
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class IlvFacesComponentBase
context
- The current faces context.stateObj
- The previously saved state of this component.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.