T
- property type used by the related field.public class FileTransformer<T extends UploadReceiver> extends Object implements Transformer<T>
Transformer
that handle a Binary Item instead of a simple property.Modifier and Type | Field and Description |
---|---|
protected String |
basePropertyName |
protected BasicUploadFieldDefinition |
definition |
protected String |
i18NPropertyName
Deprecated.
since 5.4.11 - no longer use this variable.
|
protected com.vaadin.v7.data.Item |
relatedFormItem |
protected Class<T> |
type |
Constructor and Description |
---|
FileTransformer(com.vaadin.v7.data.Item relatedFormItem,
BasicUploadFieldDefinition definition,
Class<T> type)
Deprecated.
since 5.4.11 - use
FileTransformer(Item, BasicUploadFieldDefinition, Class, I18NAuthoringSupport) instead. |
FileTransformer(com.vaadin.v7.data.Item relatedFormItem,
BasicUploadFieldDefinition definition,
Class<T> type,
I18NAuthoringSupport i18NAuthoringSupport) |
Modifier and Type | Method and Description |
---|---|
T |
createPropertyFromItem(com.vaadin.v7.data.Item item) |
String |
getBasePropertyName()
Returns the property base name that the
I18NAuthoringSupport should use. |
protected String |
getItemName()
Based on the i18n information, define the item name to use.
|
Locale |
getLocale() |
protected com.vaadin.v7.data.Item |
getOrCreateFileItem() |
protected com.vaadin.v7.data.Property |
getOrCreateProperty(com.vaadin.v7.data.Item item,
String propertyName,
Class<?> type)
Get the required property from the Item, or create it if it does not exist.
|
protected JcrNodeAdapter |
getRootItem()
Defines the root item used to retrieve and create child items.
|
protected List<javax.jcr.Node> |
getStoredChildNodes(JcrNodeAdapter parent)
Fetches child nodes of the given parent from JCR, filtered using the
NodeUtil.MAGNOLIA_FILTER predicate. |
Class<T> |
getType() |
protected void |
handleInvalid(T newValue,
com.vaadin.v7.data.Item item)
Handle the related Item in case
isValid(UploadReceiver, Item) return false. |
boolean |
hasI18NSupport()
Return true if this Property has to support i18n.
|
protected T |
initializeUploadReceiver() |
boolean |
isReadOnly()
Mirror the read-only state of the underlying Property / data-source.
|
protected boolean |
isValid(T newValue,
com.vaadin.v7.data.Item item) |
com.vaadin.v7.data.Item |
populateItem(T newValue,
com.vaadin.v7.data.Item item)
Populate the related Item with the values of 'newItem' in case
isValid(UploadReceiver, Item) return true. |
protected void |
populateStoredChildItems(JcrNodeAdapter rootItem)
Populates the given root item with its child items.
|
T |
readFromItem()
Get the stored Item, and based of this Item, return
createPropertyFromItem(Item) . |
void |
setI18NPropertyName(String i18nPropertyName)
Deprecated.
since 5.4.11 - no longer use this function.
|
void |
setLocale(Locale locale) |
void |
setReadOnly(boolean isReadOnly)
Deprecated.
|
void |
writeToItem(T newValue)
Base on the validity of the received property, populate or not the property to the related Item.
|
protected com.vaadin.v7.data.Item relatedFormItem
protected final BasicUploadFieldDefinition definition
protected final Class<T extends UploadReceiver> type
protected String basePropertyName
@Deprecated protected String i18NPropertyName
@Inject public FileTransformer(com.vaadin.v7.data.Item relatedFormItem, BasicUploadFieldDefinition definition, Class<T> type, I18NAuthoringSupport i18NAuthoringSupport)
@Deprecated public FileTransformer(com.vaadin.v7.data.Item relatedFormItem, BasicUploadFieldDefinition definition, Class<T> type)
FileTransformer(Item, BasicUploadFieldDefinition, Class, I18NAuthoringSupport)
instead.public void writeToItem(T newValue)
populateItem(UploadReceiver, Item)
in case isValid(UploadReceiver, Item)
return true. handleInvalid(UploadReceiver, Item)
.writeToItem
in interface Transformer<T extends UploadReceiver>
public T readFromItem()
createPropertyFromItem(Item)
.readFromItem
in interface Transformer<T extends UploadReceiver>
protected com.vaadin.v7.data.Item getOrCreateFileItem()
protected String getItemName()
public T createPropertyFromItem(com.vaadin.v7.data.Item item)
protected T initializeUploadReceiver()
protected boolean isValid(T newValue, com.vaadin.v7.data.Item item)
populateItem(UploadReceiver, Item)
.public com.vaadin.v7.data.Item populateItem(T newValue, com.vaadin.v7.data.Item item)
isValid(UploadReceiver, Item)
return true.writeToItem(UploadReceiver)
protected void handleInvalid(T newValue, com.vaadin.v7.data.Item item)
isValid(UploadReceiver, Item)
return false.writeToItem(UploadReceiver)
protected com.vaadin.v7.data.Property getOrCreateProperty(com.vaadin.v7.data.Item item, String propertyName, Class<?> type)
protected JcrNodeAdapter getRootItem()
protected void populateStoredChildItems(JcrNodeAdapter rootItem)
protected List<javax.jcr.Node> getStoredChildNodes(JcrNodeAdapter parent)
NodeUtil.MAGNOLIA_FILTER
predicate.public String getBasePropertyName()
I18NAwareHandler
I18NAuthoringSupport
should use.getBasePropertyName
in interface I18NAwareHandler
public Class<T> getType()
getType
in interface Transformer<T extends UploadReceiver>
value
must be assignable
to this type.public boolean isReadOnly()
Transformer
isReadOnly
in interface Transformer<T extends UploadReceiver>
@Deprecated public void setReadOnly(boolean isReadOnly)
setReadOnly
in interface Transformer<T extends UploadReceiver>
public boolean hasI18NSupport()
Transformer
hasI18NSupport
in interface Transformer<T extends UploadReceiver>
public void setLocale(Locale locale)
setLocale
in interface I18NAwareHandler
@Deprecated public void setI18NPropertyName(String i18nPropertyName)
setI18NPropertyName
in interface I18NAwareHandler
public Locale getLocale()
getLocale
in interface I18NAwareHandler
Copyright © 2019 Magnolia International Ltd.. All rights reserved.