Package org.olat.core.gui.components.link

Summary:

See:
          Description

Class Summary
FormLinkFactory Description:
TODO: patrickb Class Description for FormLinkFactory
Link Description:
Use @see LinkFactory to get Link objects.
LinkFactory Description:
offer convenience methods to create and add buttons/links to Velocity Containers quick and easy Typical usage (see also GuiDemoLinksController.java): instantiate your VelocityContrainter
mainVC = createVelocityContainer("guidemo-links"); create your button
button = LinkFactory.createButton("button", mainVC, this); save it as instance variable, that the controller can listeningController catch its events add to your velocity page, that shows up the button $r.render("button") and finally listen to the events the button fired in the listeningController.event(UserRequest ureq, Component source, Event event)
public void event(UserRequest ureq, Component source, Event event) { if (source == button){ // do something } } Initial Date: August 10, 2006
LinkRenderer Description: Renders the link component depending of features and style.
 

Enum Summary
Link.MouseEvent valid events for the register mouse event stuff
 

Package org.olat.core.gui.components.link Description

Summary:

The Link is a component which fires an event to its listener when a user is clicking it. It is rendered by the LinkRenderer and can have different appearances. It can look like a typical hyper link, a button or even like an icon.

The LinkFactory provides a set of convenience methods. In the most cases you have only to set three parameters: the first one for the name of the link, the command and the translation key; the second one for the VelocityContainer, where the link is displayed to the user; the third one for the listener.