001: /*
002: *
003: *
004: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: */
026: package com.sun.perseus.model;
027:
028: import com.sun.perseus.util.SVGConstants;
029:
030: import org.w3c.dom.events.Event;
031:
032: /**
033: * A <code>AccessKeyCondition</code> generates a <code>TimeInstance</code>
034: * everytime the associated key event occurs with the expected
035: * <code>accessKey</code> value.
036: *
037: * @version $Id: AccessKeyCondition.java,v 1.2 2006/04/21 06:36:24 st125089 Exp $
038: */
039: public final class AccessKeyCondition extends EventBaseCondition {
040: /**
041: * The key code which triggers the condition.
042: */
043: char accessKey;
044:
045: /**
046: * @param timedElement the associated <code>TimedElementSupport</code>.
047: * Should not be null.
048: * @param isBegin defines whether this condition is for a begin list.
049: * @param offset offset from the sync base. This means that time instances
050: * synchronized on the syncBase begin or end time are offset by
051: * this amount.
052: * @param accessKey only when the eventBase generates a key event with
053: * this accessKey will a <code>TimeInstance</code> be generated.
054: */
055: public AccessKeyCondition(final TimedElementSupport timedElement,
056: final boolean isBegin, final long offset,
057: final char accessKey) {
058: super (timedElement, isBegin, null,
059: timedElement.animationElement.ownerDocument,
060: SVGConstants.SVG_KEYDOWN_EVENT_TYPE, offset);
061:
062: this .accessKey = accessKey;
063: }
064:
065: /**
066: * Implementation of the <code>EventListener</code> interface.
067: * This is a simple filtered version of the handleEvent implementation
068: * in <code>EventBaseCondition</code>.
069: *
070: * @param evt the event that occured
071: */
072: public void handleEvent(final Event evt) {
073: if (((ModelEvent) evt).keyChar == accessKey) {
074: super .handleEvent(evt);
075: }
076: }
077:
078: /**
079: * Converts this <code>AccessKeyCondition</code> to a String trait.
080: *
081: * @return a string describing this <code>TimeCondition</code>
082: */
083: protected String toStringTrait() {
084: StringBuffer sb = new StringBuffer();
085:
086: sb.append("accessKey(");
087: sb.append(accessKey);
088: sb.append(')');
089:
090: if (offset != 0) {
091: if (offset > 0) {
092: sb.append('+');
093: }
094: sb.append(offset / 1000f);
095: sb.append('s');
096: }
097:
098: return sb.toString();
099: }
100:
101: }
|