blob: eb47a064dc1ec4f61f3f668fa150e093c520d6aa [file] [log] [blame]
<md-content layout="column" layout-align="center stretch" class="content">
<ul class="breadcrumb">
<li><a href="#/documentation/2.0.2">2.0.2</a> <span class="divider">/</span></li>
<li><a href="#/documentation/2.0.2/language/overview">Language</a> <span class="divider">/</span></li>
<li><a href="#/documentation/2.0.2/language/widgets">Widgets</a></li>
<h2 id="Hyperlink">Hyperlink</h2>
<h3 id="description">Description</h3>
<p>The hyperlink widget can be used to display a read-only piece of text in your user interface and allow the user to click on it. Its behavior is almost the same as the
<a href="#/documentation/2.0.2/language/widgets/label">label</a> or the
<a href="#/documentation/2.0.2/language/widgets/text">text</a> widgets. On top of the common properties of all widgets (identifier, labelExpression, helpExpression, isEnabledExpression, propertyValidationRules), it has the following properties:
<li>valueExpression: This expression is used in order to compute the text of the hyperlink.</li>
<li>displayExpression: This expression will have access to the result of the valueExpression thanks to a variable named value and it should return a string. If this expression is blank, a call to java.lang.Object#toString() will be performed on the result of the valueExpression instead.</li>
<li>onClickExpression: This expression will be executed once the end user will click on the hyperlink. This expression does not have to return anything.</li>
<li>style: The style of the hyperlink widget.</li>
<li>conditionalStyles: All the conditional styles of the hyperlink widget.</li>
<li>actions: All the widget actions of the hyperlink. Widget actions will be represented in the user interface by buttons.</li>
<p>A widget action contains only the following properties:</p>
<li>labelExpression: This expression is used to compute the label of the button. It should return a string.</li>
<li>actionExpression: This expression is used to define the behavior of the button. It will be executed when the end user will click on the button. It should not return anything.</li>
<li>imageExpression: This expression is used to compute the image to display in the button. This expression must return a string with the following structure PROJECT_NAME/IMAGE_PATH.</li>
<h3 id="displayanaction">Display an action</h3>
<p>In order to create a hyperlink widget, you can use the following properties:</p>
<p>EEF does not provide a default interpreter but you can easily configure EEF to be used with the AQL interpreter. In the integration of EEF with the AQL interpreter, you can register additional services, written in Java, in which you can expose to AQL new operations.</p>