com.vaadin.ui
Class Link

java.lang.Object
  com.vaadin.terminal.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          com.vaadin.ui.Link

All Implemented Interfaces:

MethodEventSource, Connector, ClientConnector, RpcTarget, Sizeable, Vaadin6Component, VariableOwner, Component, Serializable, EventListener

public class Link
extends AbstractComponent
implements Vaadin6Component

Link is used to create external or internal URL links.

Since:

3.0

Version:

7.0.0.alpha3

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent

AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler

Nested classes/interfaces inherited from interface com.vaadin.terminal.VariableOwner

VariableOwner.ErrorEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.terminal.Sizeable

Sizeable.Unit

Field Summary

static int	TARGET_BORDER_DEFAULT
static int	TARGET_BORDER_MINIMAL
static int	TARGET_BORDER_NONE

Fields inherited from interface com.vaadin.terminal.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Link()
Creates a new link.

Link(String caption, Resource resource)
Creates a new instance of Link.

Link(String caption, Resource resource, String targetName, int width, int height, int border)
Creates a new instance of Link that opens a new window.

Method Summary

void	changeVariables(Object source, Map<String,Object> variables) Called when one or more variables handled by the implementing class are changed.
Resource	getResource() Returns the resource this link opens.
int	getTargetBorder() Returns the target window border.
int	getTargetHeight() Returns the target window height or -1 if not set.
String	getTargetName() Returns the target window name.
int	getTargetWidth() Returns the target window width or -1 if not set.
void	paintContent(PaintTarget target) Paints the content of this component.
void	setResource(Resource resource) Sets the resource this link opens.
void	setTargetBorder(int targetBorder) Sets the border of the target window.
void	setTargetHeight(int targetHeight) Sets the target window height.
void	setTargetName(String targetName) Sets the target window name.
void	setTargetWidth(int targetWidth) Sets the target window width.

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addShortcutListener, addStyleName, attach, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireEvent, focus, getActionManager, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getRoot, getState, getStyle, getStyleName, getWidth, getWidthUnits, handleError, hasListeners, isConnectorEnabled, isEnabled, isImmediate, isReadOnly, isVisible, removeListener, removeListener, removeListener, removeListener, removeListener, removeShortcutListener, removeStyleName, requestRepaint, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setHeight, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidth, updateState

Methods inherited from class com.vaadin.terminal.AbstractClientConnector

addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.terminal.VariableOwner

isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getApplication, getCaption, getDebugId, getIcon, getLocale, getParent, getRoot, getState, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible, updateState

Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector

detach, getExtensions, getStateType, isConnectorEnabled, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setParent

Methods inherited from interface com.vaadin.terminal.gwt.client.Connector

getConnectorId

Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget

getRpcManager

Methods inherited from interface com.vaadin.terminal.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth

Field Detail

TARGET_BORDER_NONE

public static final int TARGET_BORDER_NONE

See Also:

Constant Field Values

TARGET_BORDER_MINIMAL

public static final int TARGET_BORDER_MINIMAL

See Also:

Constant Field Values

TARGET_BORDER_DEFAULT

public static final int TARGET_BORDER_DEFAULT

See Also:

Constant Field Values

Constructor Detail

Link

public Link()

Creates a new link.

Link

public Link(String caption,
            Resource resource)

Creates a new instance of Link.

Parameters:

caption -

resource -

Link

public Link(String caption,
            Resource resource,
            String targetName,
            int width,
            int height,
            int border)

Creates a new instance of Link that opens a new window.

Parameters:

caption - the Link text.

targetName - the name of the target window where the link opens to. Empty name of null implies that the target is opened to the window containing the link.

width - the Width of the target window.

height - the Height of the target window.

border - the Border style of the target window.

Method Detail

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Paints the content of this component.

Specified by:

paintContent in interface Vaadin6Component

Parameters:

target - the Paint Event.

Throws:

PaintException - if the paint operation failed.

getTargetBorder

public int getTargetBorder()

Returns the target window border.

Returns:

the target window border.

getTargetHeight

public int getTargetHeight()

Returns the target window height or -1 if not set.

Returns:

the target window height.

getTargetName

public String getTargetName()

Returns the target window name. Empty name of null implies that the target is opened to the window containing the link.

Returns:

the target window name.

getTargetWidth

public int getTargetWidth()

Returns the target window width or -1 if not set.

Returns:

the target window width.

setTargetBorder

public void setTargetBorder(int targetBorder)

Sets the border of the target window.

Parameters:

targetBorder - the targetBorder to set.

setTargetHeight

public void setTargetHeight(int targetHeight)

Sets the target window height.

Parameters:

targetHeight - the targetHeight to set.

setTargetName

public void setTargetName(String targetName)

Sets the target window name.

Parameters:

targetName - the targetName to set.

setTargetWidth

public void setTargetWidth(int targetWidth)

Sets the target window width.

Parameters:

targetWidth - the targetWidth to set.

getResource

public Resource getResource()

Returns the resource this link opens.

Returns:

the Resource.

setResource

public void setResource(Resource resource)

Sets the resource this link opens.

Parameters:

resource - the resource to set.

changeVariables

public void changeVariables(Object source,
                            Map<String,Object> variables)

Description copied from interface: VariableOwner

Called when one or more variables handled by the implementing class are changed.

Specified by:

changeVariables in interface VariableOwner

Parameters:

source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

variables - the Mapping from variable names to new variable values.