Class WAbstractArea
- Direct Known Subclasses:
WCircleArea
,WPolygonArea
,WRectArea
public abstract class WAbstractArea extends WObject
Use an WAbstractArea (or rather, one of its concrete implementations), to define interactivity
that applies on a part of a WImage
or WPaintedWidget
. The area may be defined
using different shapes through WRectArea
, WCircleArea
or WPolygonArea
.
-
Nested Class Summary
Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject
WObject.FormData
-
Method Summary
Modifier and Type Method Description void
addStyleClass(java.lang.String styleClass, boolean force)
Adds a style class.EventSignal1<WMouseEvent>
clicked()
Event signal emitted when a mouse key was clicked on this widget.EventSignal1<WMouseEvent>
doubleClicked()
Event signal emitted when a mouse key was double clicked on this widget.EventSignal
enterPressed()
Event signal emitted when enter was pressed.EventSignal
escapePressed()
Event signal emitted when escape was pressed.WString
getAlternateText()
Returns the alternate text.Cursor
getCursor()
Returns the cursor.protected java.lang.String
getJsRef()
WLink
getLink()
Returns the link.java.lang.String
getRef()
Deprecated.WResource
getResource()
Deprecated.UsegetLink()
instead.java.lang.String
getStyleClass()
Returns the style class.AnchorTarget
getTarget()
Returns the location where the referred content should be displayed.WString
getToolTip()
Returns the tooltip text.protected abstract java.lang.String
getUpdateAreaCoordsJS()
boolean
isHole()
Returns whether this area specifies a hole.boolean
isTransformable()
EventSignal1<WKeyEvent>
keyPressed()
Event signal emitted when a "character" was entered.EventSignal1<WKeyEvent>
keyWentDown()
Event signal emitted when a keyboard key is pushed down.EventSignal1<WKeyEvent>
keyWentUp()
Event signal emitted when a keyboard key is released.EventSignal1<WMouseEvent>
mouseDragged()
Event signal emitted when the mouse is dragged over this widget.EventSignal1<WMouseEvent>
mouseMoved()
Event signal emitted when the mouse moved over this widget.EventSignal1<WMouseEvent>
mouseWentDown()
Event signal emitted when a mouse key was pushed down on this widget.EventSignal1<WMouseEvent>
mouseWentOut()
Event signal emitted when the mouse went out of this widget.EventSignal1<WMouseEvent>
mouseWentOver()
Event signal emitted when the mouse entered this widget.EventSignal1<WMouseEvent>
mouseWentUp()
Event signal emitted when a mouse key was released on this widget.EventSignal1<WMouseEvent>
mouseWheel()
Event signal emitted when the mouse scroll wheel was used.void
remove()
Destructor.void
removeStyleClass(java.lang.String styleClass, boolean force)
Removes a style class.void
setAlternateText(java.lang.CharSequence text)
Sets an alternate text.void
setCursor(Cursor cursor)
Sets the cursor.void
setCursor(java.lang.String cursorImage)
Sets a custom cursor image URL.void
setCursor(java.lang.String cursorImage, Cursor fallback)
Sets a custom cursor image URL.void
setHole(boolean hole)
Specifies that this area specifies a hole for another area.void
setLink(WLink link)
Sets a link.void
setRef(java.lang.String ref)
Deprecated.UsesetLink()
instead.void
setResource(WResource resource)
Deprecated.UsesetLink()
instead.void
setStyleClass(java.lang.String styleClass)
Defines a style class.void
setTarget(AnchorTarget target)
Specifies the location where the referred content should be displayed.void
setToolTip(java.lang.CharSequence text)
Sets the tooltip.void
setTransformable(boolean transformable)
protected boolean
updateDom(DomElement element, boolean all)
Methods inherited from class eu.webtoolkit.jwt.WObject
addChild, getId, getObjectName, setFormData, setObjectName, tr
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Method Details
-
remove
public void remove()Destructor.The area is automatically removed from the
WImage
orWPaintedWidget
to which it was added.- Overrides:
remove
in classWObject
- See Also:
WImage.removeArea(WAbstractArea area)
,WPaintedWidget.removeArea(WAbstractArea area)
-
setHole
public void setHole(boolean hole)Specifies that this area specifies a hole for another area.When set to
true
, this area will define an area that does not provide interactivity. When it preceeds other, overlapping, areas, it acts as if it cuts a hole in those areas.The default value is
false
.- See Also:
isHole()
-
isHole
public boolean isHole()Returns whether this area specifies a hole.- See Also:
setHole(boolean hole)
-
setTransformable
public void setTransformable(boolean transformable) -
isTransformable
public boolean isTransformable() -
setLink
Sets a link.By setting a link, the area behaves like a
WAnchor
.By default, no destination link is set.
Note: Even when no destination link is set, in some circumstances, an identity URL ('#') will be linked to on the underlying HTML <area> element (see also
setCursor()
). -
getLink
Returns the link.- See Also:
setLink(WLink link)
-
setRef
public void setRef(java.lang.String ref)Deprecated.UsesetLink()
instead.Sets the destination URL (deprecated).By setting a destination URL, the area behaves like a
WAnchor
.By default, no destination URL is set (
ref
= "").This method should not be used when the area has been pointed to a dynamically generated resource using
setResource()
. -
getRef
public java.lang.String getRef()Deprecated.UsegetLink()
instead.Returns the the destination URL (deprecated).When the area refers to a resource, the current resource URL is returned.
- See Also:
setRef(String ref)
,WResource.getUrl()
-
setResource
Deprecated.UsesetLink()
instead.Sets a destination resource (deprecated).A resource specifies application-dependent content, which may be generated by your application on demand.
By setting a resource, the area behaves like a
WAnchor
that links to the resourceresource
. The resource may be cleared by passingresource
=null
.The area does not assume ownership of the resource.
- See Also:
setRef(String ref)
-
getResource
Deprecated.UsegetLink()
instead.Returns the destination resource (deprecated).Returns
null
if no resource has been set.- See Also:
setResource(WResource resource)
-
setTarget
Specifies the location where the referred content should be displayed.This configures the location where referred content should be displayed, that was specified using
setRef()
orsetResource()
.By default, the reference is displayed in the application (
AnchorTarget.TargetSelf
). When the destination is an HTML document, the application is replaced with the new document. When the reference is a document that cannot be displayed in the browser, it is offered for download or opened using an external program, depending on browser settings.By setting
target
toAnchorTarget.TargetNewWindow
, the destination is displayed in a new browser window or tab. -
getTarget
Returns the location where the referred content should be displayed.- See Also:
setTarget(AnchorTarget target)
-
setAlternateText
public void setAlternateText(java.lang.CharSequence text)Sets an alternate text.The alternate text should provide a fallback for browsers that do not display an image. If no sensible fallback text can be provided, an empty text is preferred over nonsense.
This should not be confused with
getToolTip()
text, which provides additional information that is displayed when the mouse hovers over the area.The default alternate text is an empty text ("").
- See Also:
getAlternateText()
-
getAlternateText
Returns the alternate text.- See Also:
setAlternateText(CharSequence text)
-
setToolTip
public void setToolTip(java.lang.CharSequence text)Sets the tooltip.The tooltip is displayed when the cursor hovers over the area.
-
getToolTip
Returns the tooltip text.- See Also:
setToolTip(CharSequence text)
-
setStyleClass
public void setStyleClass(java.lang.String styleClass)Defines a style class.Note: Only few CSS declarations are known to affect the look of a image area, the most notable one being the 'cursor'. Other things will simply be ignored.
-
getStyleClass
public java.lang.String getStyleClass()Returns the style class.- See Also:
setStyleClass(String styleClass)
-
addStyleClass
public void addStyleClass(java.lang.String styleClass, boolean force)Adds a style class.Note: Only few CSS declarations are known to affect the look of a image area, the most notable one being the 'cursor'. Other things will simply be ignored.
-
removeStyleClass
public void removeStyleClass(java.lang.String styleClass, boolean force)Removes a style class. -
setCursor
Sets the cursor.This sets the mouse cursor that is shown when the mouse pointer is over the area. Most browsers only support PointingHandCursor, which is activated by a non-empty ref.
- See Also:
setRef(String ref)
-
setCursor
Sets a custom cursor image URL.The URL should point to a .cur file. For optimal portability, make sure that the .cur file is proparly constructed. A renamed .ico file will not work on Internet Explorer.
-
setCursor
public final void setCursor(java.lang.String cursorImage)Sets a custom cursor image URL. -
getCursor
Returns the cursor.- See Also:
setCursor(Cursor cursor)
-
keyWentDown
Event signal emitted when a keyboard key is pushed down.The keyWentDown signal is the first signal emitted when a key is pressed (before the
keyPressed()
signal). UnlikekeyPressed()
however it is also emitted for modifier keys (such as "shift", "control", ...) or keyboard navigation keys that do not have a corresponding character.- See Also:
keyPressed()
,keyWentUp()
-
keyPressed
Event signal emitted when a "character" was entered.The keyPressed signal is emitted when a key is pressed, and a character is entered. Unlike
keyWentDown()
, it is emitted only for key presses that result in a character being entered, and thus not for modifier keys or keyboard navigation keys.- See Also:
keyWentDown()
-
keyWentUp
Event signal emitted when a keyboard key is released.This is the counter-part of the
keyWentDown()
event. Every key-down has its corresponding key-up.- See Also:
keyWentDown()
-
enterPressed
Event signal emitted when enter was pressed.This signal is emitted when the Enter or Return key was pressed.
- See Also:
keyPressed()
,Key.Key_Enter
-
escapePressed
Event signal emitted when escape was pressed.This signal is emitted when the Escape key was pressed.
- See Also:
keyPressed()
,Key.Key_Escape
-
clicked
Event signal emitted when a mouse key was clicked on this widget.The event details contains information such as the
WMouseEvent.getButton()
, optionalkeyboard modifiers
, and mouse coordinates relative to theWMouseEvent.getWidget()
, the windowWMouseEvent.getWindow()
, or theWMouseEvent.getDocument()
.Note: When JavaScript is disabled, the event details contain invalid information.
-
doubleClicked
Event signal emitted when a mouse key was double clicked on this widget.The event details contains information such as the
WMouseEvent.getButton()
, optionalkeyboard modifiers
, and mouse coordinates relative to theWMouseEvent.getWidget()
, the windowWMouseEvent.getWindow()
, or theWMouseEvent.getDocument()
.Note: When JavaScript is disabled, the signal will never fire.
-
mouseWentDown
Event signal emitted when a mouse key was pushed down on this widget.The event details contains information such as the
WMouseEvent.getButton()
, optionalkeyboard modifiers
, and mouse coordinates relative to theWMouseEvent.getWidget()
, the windowWMouseEvent.getWindow()
, or theWMouseEvent.getDocument()
.Note: When JavaScript is disabled, the signal will never fire.
-
mouseWentUp
Event signal emitted when a mouse key was released on this widget.The event details contains information such as the
WMouseEvent.getButton()
, optionalkeyboard modifiers
, and mouse coordinates relative to theWMouseEvent.getWidget()
, the windowWMouseEvent.getWindow()
, or theWMouseEvent.getDocument()
.Note: When JavaScript is disabled, the signal will never fire.
-
mouseWentOut
Event signal emitted when the mouse went out of this widget.Note: When JavaScript is disabled, the signal will never fire.
-
mouseWentOver
Event signal emitted when the mouse entered this widget.Note: When JavaScript is disabled, the signal will never fire.
-
mouseMoved
Event signal emitted when the mouse moved over this widget.Note: When JavaScript is disabled, the signal will never fire.
-
mouseDragged
Event signal emitted when the mouse is dragged over this widget.The mouse event contains information on the button(s) currently pressed. If multiple buttons are currently pressed, only the button with smallest enum value is returned.
Note: When JavaScript is disabled, the signal will never fire.
-
mouseWheel
Event signal emitted when the mouse scroll wheel was used.The event details contains information such as the
wheel delta
, optionalkeyboard modifiers
, and mouse coordinates relative to theWMouseEvent.getWidget()
, the windowWMouseEvent.getWindow()
, or theWMouseEvent.getDocument()
.Note: When JavaScript is disabled, the signal will never fire.
-
updateDom
-
getUpdateAreaCoordsJS
protected abstract java.lang.String getUpdateAreaCoordsJS() -
getJsRef
protected java.lang.String getJsRef()
-
getLink()
instead.