public class FormEditableImage extends org.zkoss.zul.Window implements IntelligentField
org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl
org.zkoss.zk.ui.AbstractComponent.Children
IntelligentField.ElementType
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
ALL_EVENTS, ON_ADD_LINK, ON_ADD_LOOKUP, ON_ADD_TO_FAVORITES, ON_AFTER_QUERY, ON_BUTTON, ON_BUTTON_QUERY, ON_CANCEL, ON_CANCEL_AND, ON_CANCEL_EDIT, ON_CHANGE_DOCUMENT_SECURITY, ON_CHANGE_FOLDER_SECURITY, ON_CLEAR, ON_DELETE_SELECTED, ON_DISPLAY_POPUP, ON_DISPLAY_RESULTITEM, ON_DISPLAY_TEMPORARY_DOCUMENT, ON_DOCUMENT_ADDED, ON_DOCUMENT_CHECK, ON_DOCUMENT_FILING, ON_DOCUMENT_LOCKED, ON_DOCUMENT_RELEASE, ON_DOWNLOAD_RESULTITEM, ON_EDIT_CONTENT, ON_EDIT_FOLDER, ON_EDIT_ITEM, ON_EDIT_ITEM_SELECTED, ON_EDIT_LOOKUP, ON_EDIT_SELECTED, ON_EDIT_STRUCTURE, ON_EXPAND_NODE, ON_EXPORT, ON_FAST_ACCESS_DRAG_OVER, ON_FIELD_CHANGE, ON_FILE_ACTION, ON_FILE_PREVIEW, ON_FILE_SEARCH, ON_FORM_CREATED, ON_FORM_RENDER_ERROR, ON_FORWARD, ON_IGNORE, ON_INDEX, ON_INDEX_CLEAR, ON_INDEX_RESULTITEM, ON_ITEM_DOUBLECLICK, ON_LAUNCH_WORKFLOW, ON_LOG, ON_LOGON, ON_MACRO, ON_NAVIGATION, ON_NAVIGATION_FOLDER, ON_NAVIGATION_FORM, ON_NAVIGATION_WEBPART, ON_NEW_ITEM, ON_NEW_SELECTED, ON_OK, ON_OPEN_INDEX_MASK, ON_OPEN_MASK, ON_OPEN_QUERY_MASK, ON_PASSWORD_EXPIRED, ON_PRINT_DOCUMENTS, ON_QUERY, ON_QUERY_FAVORITE, ON_REFRESH, ON_REFRESH_FOLDER, ON_RESET_GUI, ON_REVISION_CREATED, ON_SAVE_AND, ON_SAVE_DOC, ON_SAVE_FOLDER, ON_SCROLL_NODE, ON_SELECT_TREE_ITEM, ON_SELECTDDC, ON_SEND_MAIL_RESULTITEM, ON_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_DOCUMENT, ON_UPLOAD_SUCCESS, ON_VARIABLES_AVAILABLE, ON_WF, ON_WF_COMMENT_DIALOG_CANCEL, ON_WF_COMMENT_DIALOG_OK, ON_WFCOMMENTS, ON_WFDELEGATE, ON_WFFORWARD, ON_WFFORWARD1, ON_WFFORWARD2, ON_WFFORWARD3, ON_WFFORWARD4, ON_WFFORWARD5, ON_WFHISTORY, ON_WFPUTBACK, ON_WFREMINDER, ON_WFTAKE, ON_WORKFLOW_ACTION, ON_WORKFLOW_COMMENT
Constructor and Description |
---|
FormEditableImage()
Constructor.
|
FormEditableImage(com.saperion.ngc.iform.xml.ThumbnailType node,
com.saperion.ngc.iform.xml.PosType panePos)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
attachClientScripts(com.saperion.ngc.iform.xml.EditFieldType field)
Attaches client side scripts after page load
|
void |
attachScripts(com.saperion.ngc.iform.xml.EditFieldType field,
EventChildHandler provider,
org.zkoss.zk.ui.Page newPage)
Attaches client and server side scripts after page load
|
void |
attachServerScripts(com.saperion.ngc.iform.xml.EditFieldType field,
EventChildHandler provider,
org.zkoss.zk.ui.Page newPage)
Attaches server side scripts after page load
|
void |
clear()
This method is not supported by FormEditabledImage and has no effect.
|
void |
clearErrorMessage()
Removes the validation error message if present.
|
void |
detachScripts(com.saperion.ngc.iform.xml.EditFieldType field,
org.zkoss.zk.ui.Page page) |
void |
doChangeValue(org.zkoss.zk.ui.event.Event event) |
List<com.saperion.bean.ContentStream> |
getContent() |
com.saperion.ngc.iform.xml.EditFieldType |
getEditField()
Returns the EditFieldType defining the properties of this field.
|
IntelligentField.ElementType |
getElementType()
Returns the type of this element.
|
Set<org.zkoss.zk.ui.Component> |
getEventtarget(String eventName)
Reads the event target for the given event name, if set or the root element.
|
String |
getFieldName()
Returns the name of the field.
|
String |
getLimit()
Returns the limit of this field (upper, lower or both).
|
IntelligentFormView |
getParentForm()
Returns the parent form or null if this field is not part of a form.
|
FieldResultBean |
getResultBean()
Returns a bean containing the current value, type, name and limit of this field.
|
int |
getSelectedImage() |
int |
getTabindex() |
boolean |
isChanged()
Returns true if the value of this field was changed.
|
boolean |
isContentValid()
Performs a validation and returns true, if the content is valid.
|
boolean |
isEmpty() |
boolean |
isFieldInactive()
Returns the fieldInactive parameter.
|
boolean |
isNoLocalize()
Returns the noLocalize parameter.
|
boolean |
isReadonly()
gets the readonly state of this field.
|
void |
onCancelEdit(org.zkoss.zk.ui.event.Event event)
Event handler for cancel edit event.
|
void |
onIndexChange(org.zkoss.zk.ui.event.Event event)
Event handler for index changes.
|
void |
onIndexClear(org.zkoss.zk.ui.event.Event event)
Event handler for index clear.
|
void |
onUpload(org.zkoss.zk.ui.event.Event event)
Listener for upload-events.
|
void |
onVariablesAvailable(org.zkoss.zk.ui.event.Event event)
Event handler for variablesAvailableEvent.
|
void |
setChangedImplicitly()
Sets the changed-property of this field to true.
|
void |
setChangedImplicitly(boolean fireChangedEvent)
Sets the changed-property of this field to true.
|
void |
setDefaultValue(String valueAsString)
Sets the default value.
|
void |
setDisabled(boolean disabled)
Sets the disabled state of this field.
|
void |
setEventOnOk(ButtonInfo.EventType type)
Starts event handling on enter key.
|
void |
setEventtarget(org.zkoss.zk.ui.Component comp,
String eventName)
Set the event target.
|
void |
setFieldInactive(boolean inactive)
Sets the fieldInactive parameter.
|
void |
setFieldName(String name)
Sets the name of the field.
|
void |
setLimit(String limit)
Sets the limit type.
|
void |
setNoLocalize(boolean noLocalize)
Sets the noLocalize parameter.
|
void |
setReadonly(boolean readonly)
Sets the readonle state of this field.
|
void |
setTabindex(int index)
This method is not supported by FormEditableImage and has no effect.
|
void |
setValue(com.saperion.intf.SaPropertyValue value)
Sets the value of this field.
|
void |
setValueImplicitly(com.saperion.intf.SaPropertyValue val)
Sets the value of this field and sets the changed-property of this field to true.
|
void |
setValueImplicitly(com.saperion.intf.SaPropertyValue value,
boolean fireChangedEvent)
Sets the value of this field and sets the changed-property of this field to true.
|
void |
showImageById(DocumentId documentId)
Shows the thumbnail associated to the specified document.
|
void |
updateAttribute(String attr,
Object value)
Performs a smartUpdate on the specified attribute.
|
void |
validate()
Starts validation of the field.
|
beforeChildAdded, clone, doEmbedded, doHighlighted, doModal, doOverlapped, doPopup, getBorder, getCaption, getCaptionApi, getContentSclass, getContentStyle, getDefaultActionOnShow, getMinheight, getMinwidth, getMode, getPosition, getTitle, getZclass, inEmbedded, inHighlighted, inModal, inOverlapped, inPopup, insertBefore, isClosable, isCollapsible, isMaximizable, isMaximized, isMinimizable, isMinimized, isShadow, isSizable, onChildRemoved, onClose, onModal, onPageDetached, renderProperties, service, setBorder, setBorder, setClosable, setContentSclass, setContentStyle, setDefaultActionOnShow, setDraggable, setMaximizable, setMaximized, setMinheight, setMinimizable, setMinimized, setMinwidth, setMode, setMode, setPosition, setShadow, setSizable, setTitle, setTopmost, setVisible
getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, newExtraCtrl, onChildAdded, onPageAttached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderIdSpace, response, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
focus, getHeight, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, unsetVariable
public FormEditableImage()
public FormEditableImage(com.saperion.ngc.iform.xml.ThumbnailType node, com.saperion.ngc.iform.xml.PosType panePos) throws NgcUiException
node
- Definition nodepanePos
- Pane positionNgcUiException
- UI exceptionpublic void setEventtarget(org.zkoss.zk.ui.Component comp, String eventName)
setEventtarget
in interface EventChild
comp
- Event targeteventName
- Event name or null for main targetEventChild.setEventtarget(org.zkoss.zk.ui.Component,
java.lang.String)
public Set<org.zkoss.zk.ui.Component> getEventtarget(String eventName)
getEventtarget
in interface EventChild
eventName
- Event name or null for main targetEventChild.getEventtarget(java.lang.String)
public void doChangeValue(org.zkoss.zk.ui.event.Event event)
doChangeValue
in interface IntelligentField
event
- EventIntelligentField.doChangeValue(org.zkoss.zk.ui.event.Event)
public IntelligentField.ElementType getElementType()
IntelligentField.ElementType
for a list of types.getElementType
in interface IntelligentField
IntelligentField.getElementType()
public FieldResultBean getResultBean()
getResultBean
in interface IntelligentField
IntelligentField.getResultBean()
public void onIndexChange(org.zkoss.zk.ui.event.Event event)
onIndexChange
in interface IntelligentField
event
- EventIntelligentField.onIndexChange(org.zkoss.zk.ui.event.Event)
public void onVariablesAvailable(org.zkoss.zk.ui.event.Event event)
IntelligentFormView.getIndexMaskDocument()
.onVariablesAvailable
in interface IntelligentField
event
- EventIntelligentField.onVariablesAvailable(org.zkoss.zk.ui.event.Event)
public void onCancelEdit(org.zkoss.zk.ui.event.Event event)
onCancelEdit
in interface IntelligentField
event
- eventIntelligentField.onCancelEdit(org.zkoss.zk.ui.event.Event)
public void setValue(com.saperion.intf.SaPropertyValue value)
setValue
in interface IntelligentField
value
- valueIntelligentField.setValue(com.saperion.intf.SaPropertyValue)
public void setValueImplicitly(com.saperion.intf.SaPropertyValue val)
setValueImplicitly
in interface IntelligentField
val
- valueIntelligentField.setValueImplicitly(com.saperion.intf.SaPropertyValue)
public void setValueImplicitly(com.saperion.intf.SaPropertyValue value, boolean fireChangedEvent)
setValueImplicitly
in interface IntelligentField
value
- valuefireChangedEvent
- if true, a Events.ON_CHANGE
event will be fired after the value was setIntelligentField.setValueImplicitly(com.saperion.intf.SaPropertyValue, boolean)
public void setChangedImplicitly()
setChangedImplicitly
in interface IntelligentField
IntelligentField.setChangedImplicitly()
public void setChangedImplicitly(boolean fireChangedEvent)
setChangedImplicitly
in interface IntelligentField
fireChangedEvent
- if true, a Events.ON_CHANGE
event will be firedIntelligentField.setChangedImplicitly(boolean)
public void onIndexClear(org.zkoss.zk.ui.event.Event event)
onIndexClear
in interface IntelligentField
event
- EventIntelligentField.onIndexClear(org.zkoss.zk.ui.event.Event)
public void setEventOnOk(ButtonInfo.EventType type)
setEventOnOk
in interface IntelligentField
type
- Event typeIntelligentField.setEventOnOk(com.saperion.ngc.iform.button.ButtonInfo.EventType)
public boolean isChanged()
isChanged
in interface IntelligentField
IntelligentField.isChanged()
public void onUpload(org.zkoss.zk.ui.event.Event event)
event
- Upload eventpublic void setDisabled(boolean disabled)
setDisabled
in interface IntelligentField
disabled
- DisabledIntelligentField.setDisabled(boolean)
public boolean isContentValid()
isContentValid
in interface IntelligentField
IntelligentField.isContentValid()
public String getFieldName()
getFieldName
in interface IntelligentField
IntelligentField.getFieldName()
public String getLimit()
getLimit
in interface IntelligentField
IntelligentField.getLimit()
public void setLimit(String limit)
setLimit
in interface IntelligentField
limit
- Limit typeIntelligentField.setLimit(java.lang.String)
public com.saperion.ngc.iform.xml.EditFieldType getEditField()
getEditField
in interface IntelligentField
IntelligentField.getEditField()
public void setDefaultValue(String valueAsString)
setDefaultValue
in interface IntelligentField
valueAsString
- string representation of valueIntelligentField.setDefaultValue(java.lang.String)
public void setFieldInactive(boolean inactive)
setReadonly(inactive)
.setFieldInactive
in interface IntelligentField
inactive
- valueIntelligentField.setFieldInactive(boolean)
public boolean isFieldInactive()
isFieldInactive
in interface IntelligentField
IntelligentField.isFieldInactive()
public void setFieldName(String name)
setFieldName
in interface IntelligentField
name
- field nameIntelligentField.setFieldName(java.lang.String)
public void validate()
validate
in interface IntelligentField
IntelligentField.validate()
public void clearErrorMessage()
clearErrorMessage
in interface IntelligentField
IntelligentField.clearErrorMessage()
public IntelligentFormView getParentForm()
getParentForm
in interface IntelligentField
IntelligentField.getParentForm()
public void updateAttribute(String attr, Object value)
updateAttribute
in interface IntelligentField
attr
- attribute namevalue
- attribute valueIntelligentField.updateAttribute(java.lang.String,
java.lang.Object)
public int getSelectedImage()
public List<com.saperion.bean.ContentStream> getContent()
public void showImageById(DocumentId documentId)
documentId
- document's idpublic void setReadonly(boolean readonly)
setReadonly
in interface IntelligentField
readonly
- readonlyIntelligentField.setReadonly(boolean)
public boolean isReadonly()
isReadonly
in interface IntelligentField
InputElement.setReadonly(boolean)
public boolean isNoLocalize()
Localized
isNoLocalize
in interface Localized
public void setNoLocalize(boolean noLocalize)
Localized
setNoLocalize
in interface Localized
noLocalize
- valuepublic boolean isEmpty()
isEmpty
in interface IntelligentField
IntelligentField.isEmpty()
public void setTabindex(int index)
setTabindex
in interface IntelligentField
index
- tab indexIntelligentField.setTabindex(int)
public int getTabindex()
getTabindex
in interface IntelligentField
InputElement.getTabindex()
public void clear()
clear
in interface IntelligentField
IntelligentField.clear()
public void attachScripts(com.saperion.ngc.iform.xml.EditFieldType field, EventChildHandler provider, org.zkoss.zk.ui.Page newPage)
IntelligentField
attachScripts
in interface IntelligentField
field
- The field to attach the code to.provider
- Instance of EventChildHandler
newPage
- The page on which the field is attached.public void attachClientScripts(com.saperion.ngc.iform.xml.EditFieldType field)
IntelligentField
attachClientScripts
in interface IntelligentField
field
- The field to attach the code to.public void attachServerScripts(com.saperion.ngc.iform.xml.EditFieldType field, EventChildHandler provider, org.zkoss.zk.ui.Page newPage)
IntelligentField
attachServerScripts
in interface IntelligentField
field
- The field to attach the code to.provider
- Instance of EventChildHandler
newPage
- The page on which the field is attached.public void detachScripts(com.saperion.ngc.iform.xml.EditFieldType field, org.zkoss.zk.ui.Page page)
detachScripts
in interface IntelligentField
Copyright © 2020 Hyland Software Germany GmbH. All rights reserved.