S

save(EditableValueHolder) - Method in class org.omnifaces.component.EditableValueHolderStateHelper

Save the state of the given EditableValueHolder.

save(FacesContext, StateHelper, Iterator<UIComponent>) - Static method in class org.omnifaces.component.EditableValueHolderStateHelper

Save state of any EditableValueHolder children.

SCAN_PATHS - Static variable in class org.omnifaces.facesviews.FacesViews

The name of the application scope context parameter under which a Set version of the paths that are to be scanned by faces views are kept.

scanAndStoreViews(ServletContext) - Static method in class org.omnifaces.facesviews.FacesViews

Scans for faces-views resources and stores the result at the designated location "org.omnifaces.facesviews" in the ServletContext.

SCANNED_VIEWS_EXTENSIONLESS - Static variable in class org.omnifaces.facesviews.FacesViews

The name of the application scope context parameter under which a Boolean version of the scanned views always exensionless init parameter is kept.

scanViews(ServletContext, String, Set<String>, Map<String, String>, String, Set<String>) - Static method in class org.omnifaces.facesviews.FacesViews

Scans resources (views) recursively starting with the given resource paths for a specific root path, and collects those and all unique extensions encountered in a flat map respectively set.

scanViews(ServletContext) - Static method in class org.omnifaces.facesviews.FacesViews

Scans resources (views) recursively starting with the given resource paths and returns a flat map containing all resources encountered.

scanViewsFromRootPaths(ServletContext, Map<String, String>, Set<String>) - Static method in class org.omnifaces.facesviews.FacesViews

 

ScopedRunner - Class in org.omnifaces.el

This class helps in letting code run within its own scope.

ScopedRunner(FacesContext) - Constructor for class org.omnifaces.el.ScopedRunner

 

ScopedRunner(FacesContext, Map<String, Object>) - Constructor for class org.omnifaces.el.ScopedRunner

 

ScriptFamily - Class in org.omnifaces.component.script

Base class which is to be shared between all components of the Script family.

ScriptFamily() - Constructor for class org.omnifaces.component.script.ScriptFamily

 

secondsBetween(Date, Date) - Static method in class org.omnifaces.el.functions.Dates

Returns the amount of seconds between two given dates.

SelectItemsBuilder - Class in org.omnifaces.util.selectitems

Helper class to build an array of SelectItems using various means, like via the builder pattern or a given Map.

SelectItemsBuilder() - Constructor for class org.omnifaces.util.selectitems.SelectItemsBuilder

 

SelectItemsCollector - Class in org.omnifaces.util.selectitems

Collection of utility methods for collecting SelectItem instances from various sources.

SelectItemsConverter - Class in org.omnifaces.converter

Base class for a converter that automatically converts a string representation of an Object back to its original object based on the associated select items for the component for which conversion is taking place.

SelectItemsConverter() - Constructor for class org.omnifaces.converter.SelectItemsConverter

 

SelectItemsIndexConverter - Class in org.omnifaces.converter

The SelectItemsIndexConverter automatically converts between the index of the select item value and the select item value itself based on its position in the associated select items for the component for which conversion is taking place.

SelectItemsIndexConverter() - Constructor for class org.omnifaces.converter.SelectItemsIndexConverter

 

SelectItemsUtils - Class in org.omnifaces.util.selectitems

Collection of utility methods for working with SelectItem or data represented by them.

sendFile(File, boolean) - Static method in class org.omnifaces.util.Faces

Send the given file to the response.

sendFile(byte[], String, boolean) - Static method in class org.omnifaces.util.Faces

Send the given byte array as a file to the response.

sendFile(InputStream, String, boolean) - Static method in class org.omnifaces.util.Faces

Send the given input stream as a file to the response.

sendFile(FacesContext, File, boolean) - Static method in class org.omnifaces.util.FacesLocal

 

sendFile(FacesContext, byte[], String, boolean) - Static method in class org.omnifaces.util.FacesLocal

 

sendFile(FacesContext, InputStream, String, boolean) - Static method in class org.omnifaces.util.FacesLocal

 

serializeURLSafe(String) - Static method in class org.omnifaces.util.Utils

Serialize the given string to the short possible unique URL-safe representation.

Servlets - Class in org.omnifaces.util

Collection of utility methods for the Servlet API in general.

SESSION_CREATED - Static variable in class org.omnifaces.cdi.eager.EagerBeansSessionListener

 

SESSION_MAX_CAP_PARAM_NAME - Static variable in class org.omnifaces.component.output.cache.CacheInstancePerScopeProvider

 

SESSION_TTL_PARAM_NAME - Static variable in class org.omnifaces.component.output.cache.CacheInstancePerScopeProvider

 

sessionCreated(HttpSessionEvent) - Method in class org.omnifaces.cdi.eager.EagerBeansSessionListener

 

sessionCreated(HttpSessionEvent) - Method in class org.omnifaces.eventlistener.DefaultHttpSessionListener

 

sessionDestroyed(HttpSessionEvent) - Method in class org.omnifaces.eventlistener.DefaultHttpSessionListener

 

set() - Static method in class org.omnifaces.util.concurrentlinkedhashmap.Weighers

A weigher where the value is a Set and its weight is the number of elements.

setApplication(Application) - Method in class org.omnifaces.application.OmniApplicationFactory

Sets the given application instance as the current instance.

setApplicationAttribute(String, Object) - Static method in class org.omnifaces.util.Faces

Sets the application scope attribute value associated with the given name.

setApplicationAttribute(FacesContext, String, Object) - Static method in class org.omnifaces.util.FacesLocal

 

setApplicationScopedBeans(List<Bean<?>>) - Method in class org.omnifaces.cdi.eager.EagerBeansRepository

 

setAttributes(FaceletContext, Object) - Method in class org.omnifaces.component.validator.ValidateMultipleHandler

Delegate to super and then try to get a ValueExpression representing a MultiFieldValidator implementation and set it as validator property of current ValidateMultiple component, or if it couldn't be obtained, then get a MethodExpression representing a method with the same signature as MultiFieldValidator.validateValues(FacesContext, List, List) and set it as validateMethod property of current ValidateMultiple component.

setCacheAttribute(FacesContext, String, Object) - Method in class org.omnifaces.component.output.Cache

Sets a named attribute associated with the main cache entry this component is using to store the rendering of its child components.

setCacheHeaders(HttpServletResponse, long) - Static method in class org.omnifaces.filter.CacheControlFilter

Set the cache headers.

setCacheProvider(CacheProvider, ServletContext) - Static method in class org.omnifaces.component.output.cache.CacheFactory

 

setCacheStore(Map<String, CacheEntry>) - Method in class org.omnifaces.component.output.cache.TimeToLiveCache

 

setCapacity(long) - Method in class org.omnifaces.util.concurrentlinkedhashmap.ConcurrentLinkedHashMap

Sets the maximum weighted capacity of the map and eagerly evicts entries until it shrinks to the appropriate size.

setComponents(String) - Method in class org.omnifaces.component.validator.ValidateMultipleFields

Sets the client identifiers of components which are to be validated.

setContentLength(int) - Method in class org.omnifaces.servlet.GzipHttpServletResponse

 

setContext(FacesContext) - Static method in class org.omnifaces.util.Faces

Sets the given faces context as current instance.

setContextAttribute(String, Object) - Static method in class org.omnifaces.util.Faces

Sets the Faces context attribute value associated with the given name.

setContextAttribute(FacesContext, String, Object) - Static method in class org.omnifaces.util.FacesLocal

 

setConverter(Converter) - Method in class org.omnifaces.component.output.Param

 

setConverter(Converter) - Method in class org.omnifaces.component.SimpleParam

 

setCurrentModelNode(FacesContext, TreeModel) - Method in class org.omnifaces.component.tree.Tree

Sets the current node of the tree model.

setData(T) - Method in class org.omnifaces.model.tree.AbstractTreeModel

 

setData(T) - Method in interface org.omnifaces.model.tree.TreeModel

Sets the wrapped data of the current tree node.

setDisabled(Boolean) - Method in class org.omnifaces.component.output.Cache

 

setDisabled(Boolean) - Method in class org.omnifaces.component.validator.ValidateMultipleFields

Sets whether the validation should be disabled or not.

setEnabled(boolean) - Static method in class org.omnifaces.cdi.eager.EagerBeansRequestListener

 

setEnabled(boolean) - Static method in class org.omnifaces.cdi.eager.EagerBeansSessionListener

 

setEscape(Boolean) - Method in class org.omnifaces.component.messages.OmniMessages

Sets whether the message detail and summary should be HTML-escaped.

setExecute(String) - Method in class org.omnifaces.component.script.CommandScript

Sets a space separated string of client IDs to process on ajax request.

setFaceletAttribute(String, Object) - Static method in class org.omnifaces.util.Faces

Sets the Facelet attribute value associated with the given name.

setFaceletAttribute(FacesContext, String, Object) - Static method in class org.omnifaces.util.FacesLocal

 

setFlashAttribute(String, Object) - Static method in class org.omnifaces.util.Faces

Sets the flash scope attribute value associated with the given name.

setFlashAttribute(FacesContext, String, Object) - Static method in class org.omnifaces.util.FacesLocal

 

setFocus(Boolean) - Method in class org.omnifaces.component.script.Highlight

Sets whether the first error element should gain focus.

setHeader(String, String) - Method in class org.omnifaces.servlet.GzipHttpServletResponse

 

setIf(String) - Method in class org.omnifaces.component.output.ConditionalComment

Sets the if condition.

setIncludeRequestParams(boolean) - Method in class org.omnifaces.component.input.Form

Set whether or not the request parameters should be encoded into the form's action URL.

setIncludeViewParams(boolean) - Method in class org.omnifaces.component.input.Form

Set whether or not the view parameters should be encoded into the form's action URL.

setInvalidateAll(Boolean) - Method in class org.omnifaces.component.validator.ValidateMultipleFields

Sets whether to invalidate all fields or only those which are actually invalid as per ValidateMultipleFields.shouldInvalidateInput(FacesContext, UIInput, Object)

setKey(String) - Method in class org.omnifaces.component.output.Cache

 

setLevel(Integer) - Method in class org.omnifaces.component.tree.TreeNode

Sets the level for which this node should render the items.

setList(List<?>) - Method in class org.omnifaces.converter.ListConverter

 

setList(List<?>) - Method in class org.omnifaces.converter.ListIndexConverter

 

setLocale(Locale) - Method in class org.omnifaces.el.ELContextWrapper

setLocale(Locale) - Static method in class org.omnifaces.util.Faces

Set the locale of the current view, which is to be used in localizing of the response.

setLocale(FacesContext, Locale) - Static method in class org.omnifaces.util.FacesLocal

 

setMessage(String) - Method in class org.omnifaces.component.messages.OmniMessages

Sets the single INFO message to be shown instead when this component has any faces message.

setMessage(String) - Method in class org.omnifaces.component.validator.ValidateMultipleFields

Sets the validation message to be shown.

setName(String) - Method in class org.omnifaces.component.script.CommandScript

Sets the script function name.

setName(String) - Method in class org.omnifaces.component.SimpleParam

Sets the parameter name.

setNoCacheHeaders(HttpServletResponse) - Static method in class org.omnifaces.filter.CacheControlFilter

Set the no-cache headers.

setOnbegin(String) - Method in class org.omnifaces.component.script.CommandScript

Sets a script to execute before ajax request is fired.

setOncomplete(String) - Method in class org.omnifaces.component.script.CommandScript

Sets a script to execute after ajax response is processed.

setParameters(Map<String, String>) - Method in class org.omnifaces.component.output.cache.CacheInstancePerScopeProvider

 

setParameters(Map<String, String>) - Method in interface org.omnifaces.component.output.cache.CacheProvider

Passes parameters to the cache provider implementation.

setPartialRequest(boolean) - Method in class org.omnifaces.context.OmniPartialViewContext

 

setPassThrough(boolean) - Method in class org.omnifaces.servlet.HttpServletResponseOutputWrapper

Sets whether the writing has to be passed through to the wrapped ServletOutputStream.

setPhaseId(PhaseId) - Method in class org.omnifaces.event.FacesEventWrapper

 

setPropertyResolved(boolean) - Method in class org.omnifaces.el.ELContextWrapper

setRecordSessionCreated(boolean) - Static method in class org.omnifaces.cdi.eager.EagerBeansSessionListener

 

setRender(String) - Method in class org.omnifaces.component.script.CommandScript

Sets a space separated string of client IDs to update on ajax response.

setRequestAttribute(String, Object) - Static method in class org.omnifaces.util.Faces

Sets the request scope attribute value associated with the given name.

setRequestAttribute(FacesContext, String, Object) - Static method in class org.omnifaces.util.FacesLocal

 

setRequestScopedBeansRequestURI(Map<String, List<Bean<?>>>) - Method in class org.omnifaces.cdi.eager.EagerBeansRepository

 

setRequestScopedBeansViewId(Map<String, List<Bean<?>>>) - Method in class org.omnifaces.cdi.eager.EagerBeansRepository

 

setReset(Boolean) - Method in class org.omnifaces.component.output.Cache

 

setResolver(Messages.Resolver) - Static method in class org.omnifaces.util.Messages

Set the custom message resolver.

setResponseStatus(int) - Static method in class org.omnifaces.util.Faces

Sets the HTTP response status code.

setResponseStatus(FacesContext, int) - Static method in class org.omnifaces.util.FacesLocal

 

setRowIndex(int) - Method in class org.omnifaces.model.IterableDataModel

 

setScope(String) - Method in class org.omnifaces.component.output.Cache

 

setScriptResourceRendered(FacesContext, ResourceIdentifier) - Static method in class org.omnifaces.util.Hacks

Set the given script resource as rendered.

setSessionAttribute(String, Object) - Static method in class org.omnifaces.util.Faces

Sets the session scope attribute value associated with the given name.

setSessionAttribute(FacesContext, String, Object) - Static method in class org.omnifaces.util.FacesLocal

 

setSessionMaxInactiveInterval(int) - Static method in class org.omnifaces.util.Faces

Sets the HTTP session timeout in seconds.

setSessionMaxInactiveInterval(FacesContext, int) - Static method in class org.omnifaces.util.FacesLocal

 

setSessionScopedBeans(List<Bean<?>>) - Method in class org.omnifaces.cdi.eager.EagerBeansRepository

 

setShowMessageFor(String) - Method in class org.omnifaces.component.validator.ValidateMultipleFields

Sets the client identifiers to show the validation message for.

setStyleClass(String) - Method in class org.omnifaces.component.script.Highlight

Sets the error style class which is to be applied on invalid inputs.

setStylesheetResourceRendered(FacesContext, ResourceIdentifier) - Static method in class org.omnifaces.util.Hacks

Set the given stylesheet resource as rendered.

setSubmittedValue(Object) - Method in class org.omnifaces.component.input.ViewParam

 

setTime(Integer) - Method in class org.omnifaces.component.output.Cache

 

setToList(Set<E>) - Static method in class org.omnifaces.el.functions.Converters

Converts a Set<E> to a List<E>.

setType(String) - Method in class org.omnifaces.component.validator.ValidateOrder

Sets the ordering type to be used.

setUseBuffer(Boolean) - Method in class org.omnifaces.component.output.Cache

 

setUseRequestURI(boolean) - Method in class org.omnifaces.component.input.Form

Set whether or not the request URI should be used as form's action URL.

setValidateMethod(MethodExpression) - Method in class org.omnifaces.component.validator.ValidateMultiple

Sets the validator method expression.

setValidator(MultiFieldValidator) - Method in class org.omnifaces.component.validator.ValidateMultiple

Sets the validator instance.

setValidTill(Date) - Method in class org.omnifaces.component.output.cache.CacheEntry

Sets the date that's the last moment in time the value obtained via getValue() is valid.

setValue(String) - Method in class org.omnifaces.component.output.cache.CacheEntry

Sets the value for which this object is keeping meta data

setValue(Object) - Method in class org.omnifaces.component.SimpleParam

 

setValue(Object) - Method in class org.omnifaces.component.tree.Tree

Sets the tree model.

setValue(ELContext, Object, Object, Object) - Method in class org.omnifaces.el.ELResolverWrapper

setValue(ELContext, Object) - Method in class org.omnifaces.el.ValueExpressionMethodWrapper

 

setValue(ELContext, Object) - Method in class org.omnifaces.el.ValueExpressionWrapper

 

setValueExpression(String, ValueExpression) - Method in class org.omnifaces.component.messages.OmniMessages

An override which checks if this isn't been invoked on var attribute.

setValueExpression(String, ValueExpression) - Method in class org.omnifaces.component.output.OutputFormat

An override which checks if this isn't been invoked on var attribute.

setValueExpression(String, ValueExpression) - Method in class org.omnifaces.component.tree.Tree

An override which checks if this isn't been invoked on var or varNode attribute.

setVar(String) - Method in class org.omnifaces.component.messages.OmniMessages

Sets the name of the request attribute which exposes the current faces message.

setVar(String) - Method in class org.omnifaces.component.output.OutputFormat

Sets the variable name which exposes the captured output into the request scope.

setVar(String) - Method in class org.omnifaces.component.tree.Tree

Sets the name of the request attribute which exposes the wrapped data of the current node of the tree model.

setVarNode(String) - Method in class org.omnifaces.component.tree.Tree

Sets the name of the request attribute which exposes the current node of the tree model.

setViewAttribute(String, Object) - Static method in class org.omnifaces.util.Faces

Sets the view scope attribute value associated with the given name.

setViewAttribute(FacesContext, String, Object) - Static method in class org.omnifaces.util.FacesLocal

 

setViewRoot(String) - Static method in class org.omnifaces.util.Faces

Sets the current view root to the given view ID.

setViewRoot(FacesContext, String) - Static method in class org.omnifaces.util.FacesLocal

 

setWrappedData(Object) - Method in class org.omnifaces.model.IterableDataModel

 

shouldHandleExceptionRootCause(FacesContext, Throwable) - Method in class org.omnifaces.exceptionhandler.FullAjaxExceptionHandler

Returns true if the FullAjaxExceptionHandler should handle this exception root cause.

shouldInvalidateInput(FacesContext, UIInput, Object) - Method in class org.omnifaces.component.validator.ValidateAll

In an invalidating case, invalidate only those inputs which have an empty value.

shouldInvalidateInput(FacesContext, UIInput, Object) - Method in class org.omnifaces.component.validator.ValidateAllOrNone

In an invalidating case, invalidate only those inputs which have an empty value.

shouldInvalidateInput(FacesContext, UIInput, Object) - Method in class org.omnifaces.component.validator.ValidateMultipleFields

Returns whether in in an invalidating case the given input component should be marked invalid.

shouldVisitSkipIteration(VisitContext) - Static method in class org.omnifaces.util.Components

Returns true if the given visit context contains the visit hint that iteration should be skipped.

showMessage(FacesContext, List<UIInput>) - Method in class org.omnifaces.component.validator.ValidateMultipleFields

Show the message at the desired place(s) depending on the value of the showMessageFor attribute.

SimpleParam - Class in org.omnifaces.component

This class provides a basic and default implementation of the ParamHolder interface.

SimpleParam() - Constructor for class org.omnifaces.component.SimpleParam

Default constructor.

SimpleParam(String, Object) - Constructor for class org.omnifaces.component.SimpleParam

Construct a simple param with name and value.

SimpleParam(String, Object, Converter) - Constructor for class org.omnifaces.component.SimpleParam

Construct a simple param with name, value and converter.

singleton() - Static method in class org.omnifaces.util.concurrentlinkedhashmap.Weighers

A weigher where a value has a weight of 1.

size() - Method in class org.omnifaces.util.concurrentlinkedhashmap.ConcurrentLinkedHashMap

 

size() - Method in class org.omnifaces.util.MapWrapper

SortedTreeModel<T> - Class in org.omnifaces.model.tree

A concrete implementation of TreeModel which holds the tree children in a TreeSet.

SortedTreeModel() - Constructor for class org.omnifaces.model.tree.SortedTreeModel

 

splitArray(Object, int) - Static method in class org.omnifaces.el.functions.Converters

Splits the given array into an array of subarrays of the given fragment size.

splitList(List<T>, int) - Static method in class org.omnifaces.el.functions.Converters

Splits the given list into a list of sublists of the given fragment size.

START_CONTENT_MARKER - Static variable in class org.omnifaces.component.output.Cache

 

startCDATA() - Method in class org.omnifaces.component.input.componentidparam.ConditionalResponseWriter

 

startDocument() - Method in class org.omnifaces.component.input.componentidparam.ConditionalResponseWriter

 

startElement(String, UIComponent) - Method in class org.omnifaces.component.input.componentidparam.ConditionalResponseWriter

 

startElement(ResponseWriter, UIComponent) - Method in class org.omnifaces.renderer.InlineResourceRenderer

Start the element.

startElement(ResponseWriter, UIComponent) - Method in class org.omnifaces.renderer.InlineScriptRenderer

 

startElement(ResponseWriter, UIComponent) - Method in class org.omnifaces.renderer.InlineStylesheetRenderer

 

startsWithOneOf(String, String...) - Static method in class org.omnifaces.util.Utils

Returns true if the given string starts with one of the given prefixes.

Startup - Annotation Type in org.omnifaces.cdi

Stereo type that designates a bean as an eagerly instantiated bean with application scope.

State - Class in org.omnifaces.util

Helper class for StateHelper that uses generic type-inference to make code that uses the StateHelper slightly less verbose.

State(StateHelper) - Constructor for class org.omnifaces.util.State

 

stream(InputStream, OutputStream) - Static method in class org.omnifaces.util.Utils

Stream the given input to the given output by NIO ByteBuffer.

Strings - Class in org.omnifaces.el.functions

Collection of EL functions for string manipulation.

stripExtension(String) - Static method in class org.omnifaces.util.ResourcePaths

Strips the extension from a resource if any.

stripFacesViewsPrefix(String) - Static method in class org.omnifaces.facesviews.FacesViews

Strips the special 'faces-views' prefix path from the resource if any.

stripPrefixPath(String, String) - Static method in class org.omnifaces.util.ResourcePaths

Strips the special 'faces-views' prefix path from the resource if any.

subscribeToEvent(Class<? extends SystemEvent>, SystemEventListener) - Static method in class org.omnifaces.util.Events

Adds the given system event listener to the application that get invoked every time when the given system event type is published.

subscribeToViewEvent(Class<? extends SystemEvent>, SystemEventListener) - Static method in class org.omnifaces.util.Events

Install the listener instance referenced by argument listener into the UIViewRoot as a listener for events of type systemEventClass.

subscribeToViewEvent(Class<? extends SystemEvent>, Callback.Void) - Static method in class org.omnifaces.util.Events

Install the callback instance referenced by argument listener into the UIViewRoot as a listener for events of type systemEventClass.