Info | Value |
---|---|
Component Type | org.primefaces.extensions.component.ImageAreaSelect |
Handler Class | None |
Renderer Type | org.primefaces.extensions.component.ImageAreaSelectRenderer |
Description | None |
Name | Required | Type | Description |
---|---|---|---|
aspectRatio | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String )
| A string of the form "width:height" which represents the aspect ratio to maintain. Example: "4:3". |
autoHide | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean )
| If set to true, selection area will disappear when selection ends. Default value: false. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent )
| An EL expression referring to a server side UIComponent instance in a backing bean. |
fadeSpeed | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer )
| If set to a number greater than zero, showing or hiding the plugin is done with a graceful fade in/fade out animation. Default value: 0. |
for | true | jakarta.el.ValueExpression
(must evaluate to java.lang.String )
| The target image. |
handles | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean )
| If set to true, resize handles are shown on the selection area; if set to "corners", only corner handles are shown. Default value: false. |
hide | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean )
| If set to true, selection area is hidden. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String )
| Unique identifier of the component in a naming container. |
imageHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer )
| True height of the image (if scaled with the CSS width and height properties). |
imageWidth | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer )
| True width of the image (if scaled with the CSS width and height properties). |
keyboardSupport | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean )
| Enables/disables keyboard support. Default value: false. |
maxHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer )
| Maximum selection height (in pixels). |
maxWidth | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer )
| Maximum selection width (in pixels). |
minHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer )
| Minimum selection height (in pixels). |
minWidth | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer )
| Minimum selection width (in pixels). |
movable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean )
| Determines whether the selection area should be movable. Default value: true. |
parentSelector | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String )
| A jQuery object or selector string that specifies the parent element that the plugin will be appended to. Default value: "body". |
persistent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean )
| If set to true, clicking outside the selection area will not start a new selection (i.e. the user will only be able to move/resize the existing selection area). Default value: false. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean )
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
resizable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean )
| Determines whether the selection area should be resizable. Default value: true. |
show | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean )
| If set to true, selection area is shown. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String )
| Name of the client side widget. |
zIndex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer )
| The z-index value to be assigned to plugin elements; normally, imgAreaSelect figures it out automatically, but there are a few cases when it's necessary to set it explicitly. |
Output generated by Vdldoc View Declaration Language Documentation Generator.