org.efaps.ui.wicket.models.cell
Class UIFormCellCmd

java.lang.Object
  org.efaps.ui.wicket.models.AbstractInstanceObject
      org.efaps.ui.wicket.models.cell.UIAbstractCell
          org.efaps.ui.wicket.models.cell.UITableCell
              org.efaps.ui.wicket.models.cell.UIFormCell
                  org.efaps.ui.wicket.models.cell.UIFormCellCmd

All Implemented Interfaces:

java.io.Serializable, org.apache.wicket.IClusterable

public class UIFormCellCmd
extends UIFormCell

TODO comment!

Version:

$Id: UIFormCellCmd.java 4678 2010-06-05 17:01:51Z jan.moxter $

Author:

The eFaps Team

See Also:

Serialized Form

Nested Class Summary

static class

UIFormCellCmd.ExecutionStatus Enum is used to set for this UIFormCellCmd which status of execution it is in.

Constructor Summary

UIFormCellCmd(AbstractUIObject _parent, org.efaps.admin.ui.field.FieldCommand _field, org.efaps.db.Instance _instance, java.lang.String _label)

Method Summary

java.util.List<org.efaps.admin.event.Return>	executeEvents(java.lang.Object _others) Execute the underlying events.
java.lang.String	getButtonIcon() Getter method for the instance variable buttonIcon.
UIFormCellCmd.ExecutionStatus	getExecutionStatus() Getter method for instance variable executionStatus.
org.efaps.admin.ui.field.FieldCommand	getFieldCommand() Get the field this UIFormCellCmd belongs to.
java.lang.String	getRenderedContent(java.lang.String _script) Get the script to render the content for the UserInterface in case that not a standard button should be rendered.
java.lang.String	getTargetField() Getter method for instance variable targetField.
boolean	isAppend() Getter method for instance variable append.
boolean	isHideLabel() This is the getter method for the instance variable UIFormCell.hideLabel.
boolean	isRenderButton() Getter method for instance variable renderButton.
boolean	isTargetField()

Methods inherited from class org.efaps.ui.wicket.models.cell.UIFormCell

getCellLabel, getPicker, getRowSpan, getTypeName, isRequired, isValuePicker

Methods inherited from class org.efaps.ui.wicket.models.cell.UITableCell

executeEvents, getAlign, getAutoCompletion, getCellTitle, getCompareValue, getFieldUpdate, getFieldUpdateEvent, getIcon, getReference, isAutoComplete, isCheckOut, isFieldUpdate, isFixedWidth, isMultiRows, setReference

Methods inherited from class org.efaps.ui.wicket.models.cell.UIAbstractCell

getAttribute, getCellValue, getComponent, getDisplay, getField, getFieldId, getInstanceFromManager, getName, getParent, getTarget, getUiClass, hasInstanceManager, setComponent

Methods inherited from class org.efaps.ui.wicket.models.AbstractInstanceObject

getInstance, getInstanceKey, setInstanceKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIFormCellCmd

public UIFormCellCmd(AbstractUIObject _parent,
                     org.efaps.admin.ui.field.FieldCommand _field,
                     org.efaps.db.Instance _instance,
                     java.lang.String _label)
              throws org.efaps.util.EFapsException

Parameters:

_parent - Parent object

_field - field this cellbelongs to

_instance - instance this field belongs to

_label - label of the field

Throws:

org.efaps.util.EFapsException - on error

Method Detail

executeEvents

public java.util.List<org.efaps.admin.event.Return> executeEvents(java.lang.Object _others)
                                                           throws org.efaps.util.EFapsException

Execute the underlying events.

Parameters:

_others - others

Returns:

list of returns

Throws:

org.efaps.util.EFapsException - on error

isRenderButton

public boolean isRenderButton()

Getter method for instance variable renderButton.

Returns:

value of instance variable renderButton

isAppend

public boolean isAppend()

Getter method for instance variable append.

Returns:

value of instance variable append

getRenderedContent

public java.lang.String getRenderedContent(java.lang.String _script)
                                    throws org.efaps.util.EFapsException

Get the script to render the content for the UserInterface in case that not a standard button should be rendered.

Parameters:

_script - additional script from the UserInterface

Returns:

html snipplet

Throws:

org.efaps.util.EFapsException - on error

getExecutionStatus

public UIFormCellCmd.ExecutionStatus getExecutionStatus()

Getter method for instance variable executionStatus.

Returns:

value of instance variable executionStatus

getFieldCommand

public org.efaps.admin.ui.field.FieldCommand getFieldCommand()

Get the field this UIFormCellCmd belongs to.

Returns:

fieldcommand

getButtonIcon

public java.lang.String getButtonIcon()

Getter method for the instance variable buttonIcon.

Returns:

value of instance variable buttonIcon

isTargetField

public boolean isTargetField()

Returns:

true if not null

isHideLabel

public boolean isHideLabel()

This is the getter method for the instance variable UIFormCell.hideLabel.

Overrides:

isHideLabel in class UIFormCell

Returns:

value of instance variable UIFormCell.hideLabel

getTargetField

public java.lang.String getTargetField()

Getter method for instance variable targetField.

Returns:

value of instance variable targetField