public class AdvancedLookupField extends org.zkoss.zul.Hbox implements IntelligentField, Identifiable, LookupField
POPUP_FIELD_ATTRIBUTE
from the form.org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl
org.zkoss.zk.ui.AbstractComponent.Children
IntelligentField.ElementType
Modifier and Type | Field and Description |
---|---|
static String |
POPUP_FIELD_ATTRIBUTE
Name of the attribute of the form in the popup that contains this field.
|
AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED
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_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
ON_LOOKUP_SELECTED
Constructor and Description |
---|
AdvancedLookupField()
Constructor to be used when the field is not part of a form.
|
AdvancedLookupField(com.saperion.ngc.iform.xml.EditFieldType field,
com.saperion.ngc.iform.xml.PosType panePosition)
Constructor to be used when the field is part of a form.
|
AdvancedLookupField(String formName)
Constructor to be used when the field is not part of a form.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clears the value(s) of this field.
|
void |
clearErrorMessage()
Removes the validation error message if present.
|
void |
clearSelectedRow()
Clears the selected row from the field.
|
void |
doChangeValue(org.zkoss.zk.ui.event.Event event) |
String |
generateUUID() |
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.
|
InternalField |
getInternalField() |
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.
|
String |
getPopupFormName() |
com.saperion.intf.SaPropertyValue |
getPropertyValue()
Returns the current value of the field as
SaPropertyValue . |
FieldResultBean |
getResultBean()
Returns a bean containing the current value, type, name and limit of this field.
|
ResultProperties |
getSelectedRow()
Returns the selected row in the lookup table belonging to this lookup field.
|
int |
getTabindex() |
<T> T |
getTypedValue()
Returns the typed value of this AdvancedLookupField.
|
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.
|
void |
onCancelEdit(org.zkoss.zk.ui.event.Event event)
Event handler for cancel edit event.
|
void |
onCreate(org.zkoss.zk.ui.event.Event event)
Event handler for
EventChild.ON_FORM_CREATED event. |
void |
onCtrlKey(org.zkoss.zk.ui.event.Event event)
Event handler for
Events.ON_CTRL_KEY events. |
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 |
onOK(org.zkoss.zk.ui.event.Event event)
Event handler for
Events.ON_OK events. |
void |
onPageAttached(org.zkoss.zk.ui.Page newpage,
org.zkoss.zk.ui.Page oldpage) |
void |
onPageDetached(org.zkoss.zk.ui.Page page) |
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 that can be used to disable localization of this component.
|
void |
setPopupFormName(String popupFormName)
Sets the name of the form to display in the popup.
|
void |
setReadonly(boolean readonly)
Sets the readonle state of this field.
|
void |
setTabindex(int index)
Sets the tabindex of this field.
|
void |
setTypedValue(Object value)
Sets the value of this AdvancedLookupField.
|
void |
setValue(com.saperion.intf.SaPropertyValue value)
Sets the value of this field.
|
void |
setValueImplicitly(com.saperion.intf.SaPropertyValue value)
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 |
updateAttribute(String attr,
Object value)
Performs a smartUpdate on the specified attribute.
|
void |
validate()
Starts validation of the field.
|
getAlign, getHeights, getOrient, getPack, getSpacing, getWidths, getZclass, isHorizontal, isSizedByContent, isVertical, renderProperties, setAlign, setHeights, setOrient, setPack, setSizedByContent, setSpacing, setWidths
clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
focus
addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride
public static final String POPUP_FIELD_ATTRIBUTE
public AdvancedLookupField()
public AdvancedLookupField(String formName)
formName
- name of the form to open in the popuppublic AdvancedLookupField(com.saperion.ngc.iform.xml.EditFieldType field, com.saperion.ngc.iform.xml.PosType panePosition)
field
- field definition from the formpanePosition
- position in the formpublic InternalField getInternalField()
public void setEventtarget(org.zkoss.zk.ui.Component comp, String eventName)
EventChild
setEventtarget
in interface EventChild
comp
- Event targeteventName
- Event name or null for main targetpublic Set<org.zkoss.zk.ui.Component> getEventtarget(String eventName)
EventChild
getEventtarget
in interface EventChild
eventName
- Event name or null for main targetpublic boolean isNoLocalize()
Localized
isNoLocalize
in interface Localized
public void setNoLocalize(boolean noLocalize)
Localized
setNoLocalize
in interface Localized
noLocalize
- valuepublic void doChangeValue(org.zkoss.zk.ui.event.Event event)
doChangeValue
in interface IntelligentField
event
- Eventpublic IntelligentField.ElementType getElementType()
IntelligentField
IntelligentField.ElementType
for a list of types.getElementType
in interface IntelligentField
public FieldResultBean getResultBean()
IntelligentField
getResultBean
in interface IntelligentField
public void onIndexChange(org.zkoss.zk.ui.event.Event event)
IntelligentField
onIndexChange
in interface IntelligentField
event
- Eventpublic void onVariablesAvailable(org.zkoss.zk.ui.event.Event event)
IntelligentField
IntelligentFormView.getIndexMaskDocument()
.onVariablesAvailable
in interface IntelligentField
event
- Eventpublic void onCancelEdit(org.zkoss.zk.ui.event.Event event)
IntelligentField
onCancelEdit
in interface IntelligentField
event
- eventpublic void onCreate(org.zkoss.zk.ui.event.Event event)
EventChild.ON_FORM_CREATED
event.event
- Create event.public void onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
onPageAttached
in interface org.zkoss.zk.ui.sys.ComponentCtrl
onPageAttached
in class org.zkoss.zk.ui.AbstractComponent
public void onPageDetached(org.zkoss.zk.ui.Page page)
onPageDetached
in interface org.zkoss.zk.ui.sys.ComponentCtrl
onPageDetached
in class org.zkoss.zk.ui.AbstractComponent
AbstractComponent.onPageDetached(org.zkoss.zk.ui.Page)
public void onOK(org.zkoss.zk.ui.event.Event event)
Events.ON_OK
events.event
- OK event.public void onCtrlKey(org.zkoss.zk.ui.event.Event event)
Events.ON_CTRL_KEY
events.event
- key eventpublic void setValue(com.saperion.intf.SaPropertyValue value)
IntelligentField
setValue
in interface IntelligentField
value
- valuepublic com.saperion.intf.SaPropertyValue getPropertyValue()
IntelligentField
SaPropertyValue
.getPropertyValue
in interface IntelligentField
public void setValueImplicitly(com.saperion.intf.SaPropertyValue value)
IntelligentField
setValueImplicitly
in interface IntelligentField
value
- valuepublic void setChangedImplicitly()
IntelligentField
setChangedImplicitly
in interface IntelligentField
public void setValueImplicitly(com.saperion.intf.SaPropertyValue value, boolean fireChangedEvent)
IntelligentField
setValueImplicitly
in interface IntelligentField
value
- valuefireChangedEvent
- if true, a Events.ON_CHANGE
event will be fired after the value was setpublic void setChangedImplicitly(boolean fireChangedEvent)
IntelligentField
setChangedImplicitly
in interface IntelligentField
fireChangedEvent
- if true, a Events.ON_CHANGE
event will be firedpublic void onIndexClear(org.zkoss.zk.ui.event.Event event)
IntelligentField
onIndexClear
in interface IntelligentField
event
- Eventpublic void setEventOnOk(ButtonInfo.EventType type)
IntelligentField
setEventOnOk
in interface IntelligentField
type
- Event typepublic boolean isChanged()
IntelligentField
isChanged
in interface IntelligentField
public void setDisabled(boolean disabled)
IntelligentField
setDisabled
in interface IntelligentField
disabled
- Disabledpublic void setReadonly(boolean readonly)
IntelligentField
setReadonly
in interface IntelligentField
readonly
- readonlypublic boolean isContentValid()
IntelligentField
isContentValid
in interface IntelligentField
public String getFieldName()
IntelligentField
getFieldName
in interface IntelligentField
public String getLimit()
IntelligentField
getLimit
in interface IntelligentField
public void setLimit(String limit)
IntelligentField
setLimit
in interface IntelligentField
limit
- Limit typepublic com.saperion.ngc.iform.xml.EditFieldType getEditField()
IntelligentField
getEditField
in interface IntelligentField
public void setDefaultValue(String valueAsString)
IntelligentField
setDefaultValue
in interface IntelligentField
valueAsString
- string representation of valuepublic void setFieldInactive(boolean inactive)
IntelligentField
setReadonly(inactive)
.setFieldInactive
in interface IntelligentField
inactive
- valuepublic boolean isFieldInactive()
IntelligentField
isFieldInactive
in interface IntelligentField
public void setFieldName(String name)
IntelligentField
setFieldName
in interface IntelligentField
name
- field namepublic void validate()
IntelligentField
validate
in interface IntelligentField
public void clearErrorMessage()
IntelligentField
clearErrorMessage
in interface IntelligentField
public IntelligentFormView getParentForm()
IntelligentField
getParentForm
in interface IntelligentField
public void updateAttribute(String attr, Object value)
IntelligentField
updateAttribute
in interface IntelligentField
attr
- attribute namevalue
- attribute valuepublic boolean isEmpty()
isEmpty
in interface IntelligentField
public <T> T getTypedValue()
ClassCastException
when the field's value cannot be converted to
the specified type. If the field contains no value, this method
returns null.List
<T>
.FieldUtil
.T
- generic type parameterpublic void setTypedValue(Object value)
Collection
of typed values.value
- value to setpublic void setTabindex(int index)
IntelligentField
setTabindex
in interface IntelligentField
setTabindex
in class org.zkoss.zk.ui.HtmlBasedComponent
index
- tab indexpublic int getTabindex()
getTabindex
in interface IntelligentField
getTabindex
in class org.zkoss.zk.ui.HtmlBasedComponent
public String generateUUID()
generateUUID
in interface Identifiable
public ResultProperties getSelectedRow()
LookupField
getSelectedRow
in interface LookupField
ResultProperties
containing the selected row or null, if no
row was selected so farpublic void clearSelectedRow()
LookupField
clearSelectedRow
in interface LookupField
public void clear()
IntelligentField
clear
in interface IntelligentField
public String getPopupFormName()
public void setPopupFormName(String popupFormName)
popupFormName
- name of the form to displayCopyright © 2016 Lexmark Enterprise Software Deutschland GmbH. All rights reserved.