com.itmill.toolkit.ui
Class Link

java.lang.Object
  com.itmill.toolkit.terminal.Identifiable
      com.itmill.toolkit.ui.AbstractComponent
          com.itmill.toolkit.ui.Link

All Implemented Interfaces:

MethodEventSource, Paintable, VariableOwner, Component, EventListener

public class Link
extends AbstractComponent

Link is used to create external or internal URL links. Internal links can be used to create action items, which change the state to application to one of the predefined states. For example, a link can be created for existing MenuTree items.

Since:

3.0

Version:

4.1.4

Author:

IT Mill Ltd.

Nested Class Summary

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.Component

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

Nested classes/interfaces inherited from interface com.itmill.toolkit.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Field Summary

static int	TARGET_BORDER_DEFAULT
static int	TARGET_BORDER_MINIMAL
static int	TARGET_BORDER_NONE

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.

Link(Window window)
Creates a new link to a window.

Method Summary

Resource	getResource() Returns the resource this link opens.
String	getTag() Gets the component UIDL tag.
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.
Window	getWindow() Returns the window this link opens.
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.
void	setWindow(Window window) Sets the window this link opens.

Methods inherited from class com.itmill.toolkit.ui.AbstractComponent

addListener, addListener, addListener, addListener, attach, changeVariables, childRequestedRepaint, dependsOn, detach, fireComponentErrorEvent, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getData, getDescription, getDirectDependencies, getErrorMessage, getIcon, getLocale, getParent, getStyle, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeDirectDependency, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDescription, setEnabled, setIcon, setImmediate, setLocale, setParent, setReadOnly, setStyle, setVisible

Methods inherited from class com.itmill.toolkit.terminal.Identifiable

getDebugId, getUIID, setDebugId, setUIID

Methods inherited from class java.lang.Object

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

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(Window window)

Creates a new link to a window.

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

getTag

public String getTag()

Gets the component UIDL tag.

Specified by:

getTag in class AbstractComponent

Returns:

the Component UIDL tag as string.

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Paints the content of this component.

Overrides:

paintContent in class AbstractComponent

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.

getWindow

public Window getWindow()

Returns the window this link opens.

Specified by:

getWindow in interface Component

Overrides:

getWindow in class AbstractComponent

Returns:

the Window.

setResource

public void setResource(Resource resource)

Sets the resource this link opens.

Parameters:

resource - the resource to set.

setWindow

public void setWindow(Window window)

Sets the window this link opens.

Parameters:

window - the window to set.