| Info | Value |
|---|---|
| Component Type | org.primefaces.component.ImageCropper |
| Handler Class | None |
| Renderer Type | None |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
alt | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Alternate text of the image. |
aspectRatio | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Double)
| Aspect ratio of the cropper area.Default is 0.0. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| An EL expression referring to a server side UIComponent instance in a backing bean.Default is generated. |
boxHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum box height of the cropping area.Default is 0. |
boxWidth | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum box width of the cropping area.Default is 0. |
cache | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Controls browser caching mode of the resource.Default is true. |
converter | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.convert.Converter)
| EL expression resolves to a converter instance or literal converter ID defining a component converter. |
converterMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
guides | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Show the dashed lines in the crop box.Default is true. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer.Default is generated. |
image | true | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Binary data to stream or context relative path. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component.Default is false. |
initialCoords | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Initial coordinates of the cropper area (x, y, width,height). |
maxSize | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Maximum size of the cropper area (width,height). |
minSize | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Minimum size of the cropper area (width,height). |
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.Default is true. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required.Default is false. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
responsive | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Re-render the cropper when resizing the window.Default is true. |
sizeLimit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Long)
| Maximum number of bytes the image.Default is 10485760L. |
validator | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.validator.Validator)
| A method expression referring to a method validating the input. |
validatorMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
valueChangeListener | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
viewMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Define the view mode of the cropper. ViewMode to 0, the crop box can extend outside the canvas, while a value of 1, 2 or 3 will restrict the crop box to the size of the canvas. ViewMode of 2 or 3 will additionally restrict the canvas to the container. Note that if the proportions of the canvas and the container are the same, there is no difference between 2 and 3.Default is 1. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
zoomOnTouch | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enable to zoom the image by dragging touch.Default is true. |
zoomOnWheel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enable to zoom the image by wheeling mouse.Default is true. |
Output generated by Vdldoc View Declaration Language Documentation Generator.