public class HtmlImage extends HtmlElement
HtmlElement.DisplayStyle
DomElement.ChildElementsIterator
DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>
Modifier and Type | Field and Description |
---|---|
static String |
TAG_NAME
The HTML tag represented by this element.
|
static String |
TAG_NAME2
Another HTML tag represented by this element.
|
ATTRIBUTE_CHECKED, ATTRIBUTE_HIDDEN, ATTRIBUTE_REQUIRED, TAB_INDEX_OUT_OF_BOUNDS
ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY, ID_ATTRIBUTE, NAME_ATTRIBUTE, SRC_ATTRIBUTE, TYPE_ATTRIBUTE, VALUE_ATTRIBUTE
PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
Modifier and Type | Method and Description |
---|---|
Page |
click()
Simulates clicking this element at the position
(0, 0) . |
Page |
click(int x,
int y)
Simulates clicking this element at the specified position.
|
protected boolean |
doClickStateUpdate(boolean shiftKey,
boolean ctrlKey)
Performs the click action on the enclosing A tag (if any).
|
void |
doOnLoad()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
|
ScriptResult |
fireEvent(Event event)
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
|
String |
getAlignAttribute()
Returns the value of the attribute
align . |
String |
getAltAttribute()
Returns the value of the attribute
alt . |
String |
getBorderAttribute()
Returns the value of the attribute
border . |
HtmlElement.DisplayStyle |
getDefaultStyleDisplay()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
|
int |
getHeight()
Returns the image's actual height (not the image's
height attribute ). |
String |
getHeightAttribute()
Returns the value of the attribute
height . |
int |
getHeightOrDefault()
Returns the value same value as the js height property.
|
String |
getHspaceAttribute()
Returns the value of the attribute
hspace . |
ImageData |
getImageData() |
String |
getIsmapAttribute()
Returns the value of the attribute
ismap . |
String |
getLocalName() |
String |
getLongDescAttribute()
Returns the value of the attribute
longdesc . |
String |
getNameAttribute()
Returns the value of the attribute
name . |
String |
getOriginalQualifiedName()
Returns the original element qualified name,
this is needed to differentiate between
img and image . |
String |
getSrc()
Returns the value of the
src value. |
String |
getSrcAttribute()
Returns the value of the attribute
src . |
String |
getUseMapAttribute()
Returns the value of the attribute
usemap . |
String |
getVspaceAttribute()
Returns the value of the attribute
vspace . |
WebResponse |
getWebResponse(boolean downloadIfNeeded)
Returns the
WebResponse for the image contained by this image element. |
int |
getWidth()
Returns the image's actual width (not the image's
width attribute ). |
String |
getWidthAttribute()
Returns the value of the attribute
width . |
int |
getWidthOrDefault()
Returns the value same value as the js width property.
|
boolean |
isComplete() |
boolean |
isDisplayed()
Returns
true if this node is displayed and can be visible to the user
(ignoring screen size, scrolling limitations, color, font-size, or overlapping nodes). |
void |
markAsCreatedByJavascript()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
|
protected void |
onAddedToPage()
Lifecycle method invoked whenever a node is added to a page.
|
void |
processImportNode(Document doc)
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
|
void |
saveAs(File file)
Saves this image as the specified file.
|
protected void |
setAttributeNS(String namespaceURI,
String qualifiedName,
String value,
boolean notifyAttributeChangeListeners,
boolean notifyMutationObservers)
Sets the value of the attribute specified by namespace and qualified name.
|
boolean |
wasCreatedByJavascript()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
|
acceptChar, addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, cloneNode, detach, doType, doType, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, handles, hasEventHandlers, isAltPressed, isAttributeCaseSensitive, isCtrlPressed, isHidden, isOptional, isRequired, isRequiredSupported, isShiftPressed, isSubmittableByEnter, isValid, notifyAttributeChangeListeners, removeAttribute, removeChild, removeHtmlAttributeChangeListener, setAttributeNode, setHidden, setHidden, setOwningForm, setRequired, type, type, type, type, typeDone
blur, click, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, fireEvent, focus, getAttribute, getAttributeDirect, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNodeType, getSchemaTypeInfo, getStaticElementsByTagName, getStyleElement, getStyleElementCaseInSensitive, getStyleMap, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isDisabledElementAndDisabled, isEmptyXmlTagExpanded, isMouseOver, isStateUpdateFirst, matches, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, printOpeningTagContentAsXml, printXml, propagateClickStateUpdateToParent, removeAttributeNode, removeAttributeNS, removeFocus, removeStyleAttribute, replaceStyleAttribute, rightClick, rightClick, setAttribute, setAttributeNodeNS, setAttributeNS, setDefaults, setId, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setInnerHtml, setNodeValue, toString, writeStyleToElement
getLowercaseName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix
addCharacterDataChangeListener, addDomChangeListener, appendChild, asNormalizedText, asXml, basicRemove, closest, compareDocumentPosition, fireCharacterDataChanged, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getDomElementDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getNextElementSibling, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousElementSibling, getPreviousSibling, getReadyState, getScriptableObject, getSelectorList, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, getVisibleText, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isAttachedToPage, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAllChildrenAddedToPage, parseHtmlSnippet, printChildrenAsXml, querySelector, querySelectorAll, quietlyRemoveAndMoveChildrenTo, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setEndLocation, setParentNode, setReadyState, setScriptableObject, setStartLocation, setTextContent, setUserData
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
appendChild, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setPrefix, setTextContent, setUserData
public static final String TAG_NAME
public static final String TAG_NAME2
protected void onAddedToPage()
super.onAddedToPage()
.onAddedToPage
in class DomNode
protected void setAttributeNS(String namespaceURI, String qualifiedName, String value, boolean notifyAttributeChangeListeners, boolean notifyMutationObservers)
setAttributeNS
in class HtmlElement
namespaceURI
- the URI that identifies an XML namespacequalifiedName
- the qualified name (prefix:local) of the attributevalue
- the value of the attributenotifyAttributeChangeListeners
- to notify the associated HtmlAttributeChangeListener
snotifyMutationObservers
- to notify MutationObserver
s or notpublic void processImportNode(Document doc)
processImportNode
in class DomNamespaceNode
doc
- the import target documentDocument.importNode(
org.htmlunit.javascript.host.dom.Node, boolean)
,
HtmlScript.processImportNode(org.htmlunit.javascript.host.dom.Document)
public void doOnLoad()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Executes this element's onload
or onerror
handler. This method downloads the image
if either of these handlers are present (prior to invoking the resulting handler), because applications
sometimes use images to send information to the server and use these handlers to get notified when the
information has been received by the server.
See here and here for the discussion which lead up to this method.
This method may be called multiple times, but will only attempt to execute the onload
or
onerror
handler the first time it is invoked.
public final String getSrcAttribute()
src
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.src
or an empty string if that attribute isn't definedpublic String getSrc()
src
value.src
valuepublic final String getAltAttribute()
alt
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.alt
or an empty string if that attribute isn't definedpublic final String getNameAttribute()
name
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.name
or an empty string if that attribute isn't definedpublic final String getLongDescAttribute()
longdesc
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.longdesc
or an empty string if that attribute isn't definedpublic final String getHeightAttribute()
height
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.height
or an empty string if that attribute isn't definedpublic final String getWidthAttribute()
width
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.width
or an empty string if that attribute isn't definedpublic final String getUseMapAttribute()
usemap
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.usemap
or an empty string if that attribute isn't definedpublic final String getIsmapAttribute()
ismap
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.ismap
or an empty string if that attribute isn't definedpublic final String getAlignAttribute()
align
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.align
or an empty string if that attribute isn't definedpublic final String getBorderAttribute()
border
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.border
or an empty string if that attribute isn't definedpublic final String getHspaceAttribute()
hspace
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.hspace
or an empty string if that attribute isn't definedpublic final String getVspaceAttribute()
vspace
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.vspace
or an empty string if that attribute isn't definedpublic int getHeight() throws IOException
Returns the image's actual height (not the image's height attribute
).
POTENTIAL PERFORMANCE KILLER - DOWNLOADS THE IMAGE - USE AT YOUR OWN RISK
If the image has not already been downloaded, this method triggers a download and caches the image.
IOException
- if an error occurs while downloading or reading the imagepublic int getHeightOrDefault()
height
propertypublic int getWidth() throws IOException
Returns the image's actual width (not the image's width attribute
).
POTENTIAL PERFORMANCE KILLER - DOWNLOADS THE IMAGE - USE AT YOUR OWN RISK
If the image has not already been downloaded, this method triggers a download and caches the image.
IOException
- if an error occurs while downloading or reading the imagepublic int getWidthOrDefault()
width
propertypublic ImageData getImageData() throws IOException
ImageData
of this imageIOException
- in case of errorpublic WebResponse getWebResponse(boolean downloadIfNeeded) throws IOException
Returns the WebResponse
for the image contained by this image element.
POTENTIAL PERFORMANCE KILLER - DOWNLOADS THE IMAGE - USE AT YOUR OWN RISK
If the image has not already been downloaded and downloadIfNeeded
is true
, this method
triggers a download and caches the image.
downloadIfNeeded
- whether or not the image should be downloaded (if it hasn't already been downloaded)null
if no download should be performed and one hasn't already been triggered; otherwise,
the response received when performing a request for the image referenced by this elementIOException
- if an error occurs while downloading the imagepublic Page click(int x, int y) throws IOException
x
- the x position of the clicky
- the y position of the clickIOException
- if an IO error occurspublic Page click() throws IOException
(0, 0)
. This method returns
the page contained by this image's window after the click, which may or may not be the
same as the original page, depending on JavaScript event handlers, etc.click
in class DomElement
IOException
- if an IO error occursprotected boolean doClickStateUpdate(boolean shiftKey, boolean ctrlKey) throws IOException
The default implementation only calls doClickStateUpdate on parent's DomElement (if any).
Subclasses requiring different behavior (like HtmlSubmitInput
) will override this method.
doClickStateUpdate
in class DomElement
shiftKey
- true
if SHIFT is pressedctrlKey
- true
if CTRL is pressedIOException
- if an IO error occurredpublic void saveAs(File file) throws IOException
file
- the file to save toIOException
- if an IO error occurspublic HtmlElement.DisplayStyle getDefaultStyleDisplay()
getDefaultStyleDisplay
in class HtmlElement
public boolean isComplete()
public boolean isDisplayed()
Returns true
if this node is displayed and can be visible to the user
(ignoring screen size, scrolling limitations, color, font-size, or overlapping nodes).
NOTE: If CSS is
disabled
, this method
does not take this element's style into consideration!
isDisplayed
in class HtmlElement
true
if the node is visible to the user, false
otherwiseDomNode.mayBeDisplayed()
public void markAsCreatedByJavascript()
public boolean wasCreatedByJavascript()
public String getOriginalQualifiedName()
img
and image
.public String getLocalName()
getLocalName
in interface Node
getLocalName
in class DomNamespaceNode
public ScriptResult fireEvent(Event event)
fireEvent
in class DomElement
event
- the event to firenull
if nothing is executedCopyright © 2002–2024 Gargoyle Software Inc.. All rights reserved.