info.novatec.testit.webtester.events.browser.SwitchedToFrameEvent Maven / Gradle / Ivy

package info.novatec.testit.webtester.events.browser;

import static java.lang.String.format;

import lombok.Getter;

import info.novatec.testit.webtester.browser.operations.FocusSetter;
import info.novatec.testit.webtester.events.AbstractEvent;
import info.novatec.testit.webtester.events.Event;
import info.novatec.testit.webtester.events.EventListener;
import info.novatec.testit.webtester.events.EventSystem;
import info.novatec.testit.webtester.pagefragments.PageFragment;


/**
 * This {@link Event event} occurs whenever a switch to another frame occurred.
 * 
 * It includes the name / ID, index or page fragment name of that target as a property.
 *
 * @see Event
 * @see EventListener
 * @see EventSystem
 * @see FocusSetter#onFrame(int)
 * @see FocusSetter#onFrame(String)
 * @see FocusSetter#onFrame(PageFragment)
 * @since 2.0
 */
@SuppressWarnings("serial")
public class SwitchedToFrameEvent extends AbstractEvent {

    @Getter
    private final String target;
    private final String type;

    public SwitchedToFrameEvent(String nameOrId) {
        this.target = nameOrId;
        this.type = "name or id";
    }

    public SwitchedToFrameEvent(int index) {
        this.target = String.valueOf(index);
        this.type = "index";
    }

    public SwitchedToFrameEvent(PageFragment frame) {
        this.target = frame.getName().orElse("unknown");
        this.type = "page fragment";
    }

    @Override
    public String describe() {
        return format("switched to frame using: %s '%s'", type, target);
    }

}