com.screenscraper.util.javascript.models.dom

Class WindowModel

java.lang.Object

com.screenscraper.util.javascript.models.ModelMapper

com.screenscraper.util.javascript.models.dom.WindowModel

All Implemented Interfaces:

java.util.Map<java.lang.Object,java.lang.Object>

public class WindowModel
extends ModelMapper

Represents the window object

Version:

7.0.3a

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WindowModel.CallbackObject

Nested classes/interfaces inherited from class com.screenscraper.util.javascript.models.ModelMapper

ModelMapper.NonexistantMethod

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WINDOW_UNDEFINED_VAR_NAME

Fields inherited from class com.screenscraper.util.javascript.models.ModelMapper

additionalFunctions, inConstructor, underlyingMap

Constructor Summary

Constructors

Constructor and Description
WindowModel(ScrapingSession session, java.lang.String userAgent)

Method Summary

Modifier and Type	Method and Description
DOMNode	convertNodeToDOMNode(org.jsoup.nodes.Node node)
void	executeCallbackIfScheduled() Executes the next scheduled callback to be run, if there is one to be run currently
ScrapingSession	getCurrentScrapingSession()
WindowModel.CallbackObject	getNextTimedMethod() This should be run in the script engine, then called.
java.util.Map<java.lang.String,java.lang.Object>	getSpecialCallbacksForClass(java.lang.Class<?> clazz)
boolean	hasNextTimedMethod() Returns whether or not there is a callback on queue that can be run
void	setAutoExecuteCallbacks(boolean autoExecuteCallbacks) Sets whether or not callbacks should be executed automatically during execution.
java.lang.Object	setInternalJavaScriptMethodHandler(java.lang.Class<?> clazz, java.lang.String name, java.lang.Object functionCallback)
java.lang.Object	setInterval(java.lang.Runnable function, java.lang.Number time, java.lang.Object... args)
java.lang.Object	setTimeout(java.lang.Runnable function, java.lang.Number time, java.lang.Object... args)
void	setUnderlyingDocument(DocumentModel documentModel) Completes initialization (the document needs to know the window when built)

Methods inherited from class com.screenscraper.util.javascript.models.ModelMapper

clear, containsKey, containsValue, entrySet, get, hasOwnProperty, isEmpty, keySet, logDebug, put, putAll, remove, runTimedCallbacks, size, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

WINDOW_UNDEFINED_VAR_NAME

public static final java.lang.String WINDOW_UNDEFINED_VAR_NAME

See Also:

Constant Field Values

Constructor Detail

WindowModel

public WindowModel(@NotNull
                   ScrapingSession session,
                   @NotNull
                   java.lang.String userAgent)

Method Detail

setInternalJavaScriptMethodHandler

public java.lang.Object setInternalJavaScriptMethodHandler(java.lang.Class<?> clazz,
                                                           java.lang.String name,
                                                           java.lang.Object functionCallback)

getSpecialCallbacksForClass

public java.util.Map<java.lang.String,java.lang.Object> getSpecialCallbacksForClass(java.lang.Class<?> clazz)

setAutoExecuteCallbacks

public void setAutoExecuteCallbacks(boolean autoExecuteCallbacks)

Sets whether or not callbacks should be executed automatically during execution. For example, if the script sets a setTimeout function with a delay of 1 millisecond, should we execute it after 1 millisecond has passed or wait and allow manual execution later. Regardless of this setting, no background threads will run to automatically run scheduled tasks. They will only be run during eval calls or on a get/put call

Parameters:

autoExecuteCallbacks - Whether or not to automatically execute callbacks as they are scheduled for run

getCurrentScrapingSession

public ScrapingSession getCurrentScrapingSession()

convertNodeToDOMNode

@NotNull
public DOMNode convertNodeToDOMNode(@NotNull
                                              org.jsoup.nodes.Node node)

setUnderlyingDocument

@InternalOnly
public void setUnderlyingDocument(@NotNull
                                                 DocumentModel documentModel)
                                          throws java.net.URISyntaxException

Completes initialization (the document needs to know the window when built)

Parameters:

documentModel - The document to set

Throws:

java.net.URISyntaxException - On error in the URL format

getNextTimedMethod

@Nullable
public WindowModel.CallbackObject getNextTimedMethod()

This should be run in the script engine, then called. It will return the CallbackObject for the next method to run (which contains a reference to the function to execute)

Returns:

The next method to run, or null if there isn't one scheduled

executeCallbackIfScheduled

public void executeCallbackIfScheduled()

Executes the next scheduled callback to be run, if there is one to be run currently

hasNextTimedMethod

public boolean hasNextTimedMethod()

Returns whether or not there is a callback on queue that can be run

Returns:

Whether or not there is a callback on queue that can be run

setInterval

public java.lang.Object setInterval(@NotNull
                                    java.lang.Runnable function,
                                    @NotNull
                                    java.lang.Number time,
                                    java.lang.Object... args)

setTimeout

public java.lang.Object setTimeout(@NotNull
                                   java.lang.Runnable function,
                                   @NotNull
                                   java.lang.Number time,
                                   java.lang.Object... args)