org.apache.myfaces.trinidadinternal.image.cache
Interface PropertiesFilter

All Known Implementing Classes:
CompositeButtonPropertiesFilter

public interface PropertiesFilter

The PropertiesFilter interface is designed to allow type-specific filtering to be performed on the client-provided "requested" properties prior to rendering an image. Filtering might be performed to enhance or modify the client-provided properties. For example, the filter might add type-specific default values for properties that are not specified by the client. Type-specific filters are registered and retrieved from ImageType instances using the PROPERTIES_FILTER_PROPERTY key.

Version:
$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/image/cache/PropertiesFilter.java#0 $) $Date: 10-nov-2005.19:06:11 $
Author:
The Oracle ADF Faces Team

Field Summary
static java.lang.Object PROPERTIES_FILTER_PROPERTY
          Key used to retrieve the PropertiesFilter property from an ImageType.
 
Method Summary
 java.util.Map<java.lang.Object,java.lang.Object> filterProperties(ImageContext context, java.util.Map<java.lang.Object,java.lang.Object> properties)
          Filters a dictionary of properties
 

Field Detail

PROPERTIES_FILTER_PROPERTY

static final java.lang.Object PROPERTIES_FILTER_PROPERTY
Key used to retrieve the PropertiesFilter property from an ImageType.

Method Detail

filterProperties

java.util.Map<java.lang.Object,java.lang.Object> filterProperties(ImageContext context,
                                                                  java.util.Map<java.lang.Object,java.lang.Object> properties)
Filters a dictionary of properties

Parameters:
context - The image context
properties - The dictionary of properties to filter
Returns:
The filtered dictionary of properties


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.