eu.webtoolkit.jwt
Class WAbstractArea

java.lang.Object
  eu.webtoolkit.jwt.WObject
      eu.webtoolkit.jwt.WAbstractArea

Direct Known Subclasses:

WCircleArea, WPolygonArea, WRectArea

public class WAbstractArea
extends WObject

Abstract base class for interactive areas in a widget.

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.

See Also:

WImage.addArea(WAbstractArea area), WPaintedWidget.addArea(WAbstractArea area)

Method Summary

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.
WLink	getLink() Returns the link.
java.lang.String	getRef() Deprecated. Use getLink() instead.
WResource	getResource() Deprecated. Use getLink() 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.
boolean	isHole() Returns whether this area specifies a hole.
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	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	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. Use setLink() instead.
void	setResource(WResource resource) Deprecated. Use setLink() 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.

Methods inherited from class eu.webtoolkit.jwt.WObject

addChild, getId, getObjectName, remove, setObjectName, tr

Methods inherited from class java.lang.Object

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

Method Detail

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)

setLink

public void setLink(WLink link)

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

public WLink getLink()

Returns the link.

See Also:

setLink(WLink link)

setRef

public void setRef(java.lang.String ref)

Deprecated. Use setLink() 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().

See Also:

Note: Even when no destination URL is set, in some circumstances, a identity URL ('#') will be set on the underlying HTML <area> element (see also {@link WAbstractArea#setCursor(Cursor cursor) setCursor()}).

getRef

public java.lang.String getRef()

Deprecated. Use getLink() 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

public void setResource(WResource resource)

Deprecated. Use setLink() 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 resource resource. The resource may be cleared by passing resource = null.

The area does not assume ownership of the resource.

See Also:

setRef(String ref)

getResource

public WResource getResource()

Deprecated. Use getLink() instead.

Returns the destination resource (deprecated).

Returns null if no resource has been set.

See Also:

setResource(WResource resource)

setTarget

public void setTarget(AnchorTarget target)

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() or setResource().

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 to AnchorTarget.TargetNewWindow, the destination is displayed in a new browser window or tab.

See Also:

setRef(String ref), setResource(WResource resource), getTarget()

getTarget

public AnchorTarget 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

public WString 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

public WString 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

public void setCursor(Cursor cursor)

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)

getCursor

public Cursor getCursor()

Returns the cursor.

See Also:

setCursor(Cursor cursor)

keyWentDown

public EventSignal1<WKeyEvent> 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). Unlike keyPressed() 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

public EventSignal1<WKeyEvent> 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

public EventSignal1<WKeyEvent> 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

public EventSignal 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

public EventSignal 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

public EventSignal1<WMouseEvent> clicked()

Event signal emitted when a mouse key was clicked on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the event details contain invalid information.

doubleClicked

public EventSignal1<WMouseEvent> doubleClicked()

Event signal emitted when a mouse key was double clicked on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the signal will never fire.

mouseWentDown

public EventSignal1<WMouseEvent> mouseWentDown()

Event signal emitted when a mouse key was pushed down on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the signal will never fire.

mouseWentUp

public EventSignal1<WMouseEvent> mouseWentUp()

Event signal emitted when a mouse key was released on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the signal will never fire.

mouseWentOut

public EventSignal1<WMouseEvent> mouseWentOut()

Event signal emitted when the mouse went out of this widget.

Note: When JavaScript is disabled, the signal will never fire.

mouseWentOver

public EventSignal1<WMouseEvent> mouseWentOver()

Event signal emitted when the mouse entered this widget.

Note: When JavaScript is disabled, the signal will never fire.

mouseMoved

public EventSignal1<WMouseEvent> mouseMoved()

Event signal emitted when the mouse moved over this widget.

Note: When JavaScript is disabled, the signal will never fire.

mouseDragged

public EventSignal1<WMouseEvent> 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

public EventSignal1<WMouseEvent> mouseWheel()

Event signal emitted when the mouse scroll wheel was used.

The event details contains information such as the wheel delta, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the signal will never fire.