001 // Copyright 2005 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 015 package org.apache.tapestry.record; 016 017 import org.apache.tapestry.IRequestCycle; 018 import org.apache.tapestry.engine.ServiceEncoding; 019 020 /** 021 * Defines the 'page' scope for persisting client properties. Persist the properties only if the 022 * current page name is the same as that of the property. 023 * 024 * @author Mindbridge 025 * @since 4.0 026 * @see org.apache.tapestry.record.ClientPropertyPersistenceScope 027 */ 028 public class PageClientPropertyPersistenceScope extends 029 AbstractPrefixedClientPropertyPersistenceScope 030 { 031 private IRequestCycle _requestCycle; 032 033 public PageClientPropertyPersistenceScope() 034 { 035 super("state:"); 036 } 037 038 /** 039 * Returns true if the active page name matches the page for this property. This means that 040 * <em>after a new page has been activated</em>, the state is discarded. 041 */ 042 043 public boolean shouldEncodeState(ServiceEncoding encoding, String pageName, 044 PersistentPropertyData data) 045 { 046 return pageName.equals(_requestCycle.getPage().getPageName()); 047 } 048 049 public void setRequestCycle(IRequestCycle requestCycle) 050 { 051 _requestCycle = requestCycle; 052 } 053 054 }