    001//  Copyright 2008 The Apache Software Foundation
    002//
    003// Licensed under the Apache License, Version 2.0 (the "License");
    004// you may not use this file except in compliance with the License.
    005// You may obtain a copy of the License at
    006//
    007//     http://www.apache.org/licenses/LICENSE-2.0
    008//
    009// Unless required by applicable law or agreed to in writing, software
    010// distributed under the License is distributed on an "AS IS" BASIS,
    011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    012// See the License for the specific language governing permissions and
    013// limitations under the License.
    014
    015package org.apache.tapestry5;
    016
    017import org.apache.tapestry5.ioc.Messages;
    018
    019/**
    020 * Provides access to blocks and messages used when overriding property labels, and property display or edit blocks.
    021 * Generally, this is a wrapper around {@link org.apache.tapestry5.ComponentResources}. An explicit implementation of
    022 * this could be used to, for example, search for override blocks in multiple places.
    023 *
    024 * @see org.apache.tapestry5.corelib.components.PropertyDisplay
    025 * @see org.apache.tapestry5.corelib.components.PropertyEditor
    026 */
    027public interface PropertyOverrides
    028{
    029    /**
    030     * Returns the override messages (normally, the messages catalog for the component's container).
    031     */
    032    Messages getOverrideMessages();
    033
    034    /**
    035     * Searches for an override block with the given name.
    036     *
    037     * @param name the name of the block (typically, an informal parameter to a component)
    038     * @return the block if found, or null if not found
    039     */
    040    Block getOverrideBlock(String name);
    041}