Package org.openxava.view

Class View

java.lang.Object
org.openxava.view.View
All Implemented Interfaces:
Serializable
public class View extends Object implements Serializable
Session object to manage a view based in maps, hence suitable for OpenXava
Author:
Javier Paniza
See Also:

  • Constructor Details

    • View

      public View()

  • Method Details

    • setRefiner

      public static void setRefiner(Object newRefiner)

    • setPolisher

      public static void setPolisher(Object newPolisher)

    • getMetaMembers

      public Collection<MetaMember> getMetaMembers()
      Throws:
      XavaException

    • setMetaMembers

      public void setMetaMembers(Collection<MetaMember> metaMembers)

    • getMetaView

      public MetaView getMetaView()
      Throws:
      XavaException
      Since:
      4.8.1

    • getMetaModel

      public MetaModel getMetaModel()
      Throws:
      XavaException

    • getValues

      public Map<String,Object> getValues()
      Copy of the values showed in view.

      It's a copy, if you change it the displayed data is not changed. If you wish change displayed data you have to use setValues or setValue.

      Throws:
      XavaException

    • getAllValues

      public Map<String,Object> getAllValues()
      Copy of all values showed in view.

      It's a copy, if you change it the displayed data is not changed. If you wish change displayed data you have to use setValues or setValue.

      Throws:
      XavaException

    • addValues

      public void addValues(Map<String,Object> values)
      Throws:
      XavaException

    • setValues

      public void setValues(Map<String,Object> values)
      Throws:
      XavaException

    • setValuesChangingModel

      public void setValuesChangingModel(Map<String,Object> values)
      Throws:
      XavaException

    • getDefaultValueInElementCollection

      public Object getDefaultValueInElementCollection(String qualifiedPropertyName)
      Since:
      5.1

    • setValuesExecutingOnChangeActions

      public void setValuesExecutingOnChangeActions(Map<String,Object> values)
      Set the values and execute the on-change actions associated to the assigned properties.

      Throws:
      XavaException

    • setValuesNotifying

      public void setValuesNotifying(Map<String,Object> values)
      Set the values and throws are events associated to the changed values.
      Throws:
      XavaException

    • getValue

      public Object getValue(String name)
      A value from the property name. The property name can be simple: 
       getValue("name");
      or qualified: 
       getValue("customer.name");
      Even you can obtain a single value from an element collection (since v5.0): 
       getValue("details.3.quantity");
      In this case you use the index for the collection after the collection name, in the case of out of range a null is returned.
      Parameters:
      name - Qualified properties are allowed
      Throws:
      XavaException

    • isMemberFromElementCollection

      public boolean isMemberFromElementCollection(String memberName)
      Since:
      6.2.2

    • getValueInt

      public int getValueInt(String name)
      Parameters:
      name - Qualified properties are allowed
      Throws:
      XavaException

    • getValueString

      public String getValueString(String name)
      Parameters:
      name - Qualified properties are allowed
      Throws:
      XavaException

    • getSubview

      public View getSubview(String name)
      Throws:
      XavaException

    • getGroupView

      public View getGroupView(String name)
      Throws:
      XavaException

    • setValueNotifying

      public void setValueNotifying(String name, Object value) throws ElementNotFoundException
      Set the value and notifies the property change, recalculating all dependent properties.
      Parameters:
      name - Can be qualified
      Throws:
      XavaException
      ElementNotFoundException

    • setValue

      public void setValue(String name, Object value)
      Set the value to the indicated member.

      If member is not of this view an exception is thrown.

      Parameters:
      name - Can be qualified
      Throws:
      XavaException - If name is not a displayed member of this view.

    • trySetValue

      public boolean trySetValue(String name, Object value)
      Try to set the value to the indicated member.

      If member does not exist in view, returns false, but it does not throw exception.

      Parameters:
      name - Can be qualified
      Returns:
      true if member exists and it's updated, false otherwise.
      Throws:
      XavaException

    • isDataChanged

      public boolean isDataChanged()
      Since:
      6.3

    • setSectionEditable

      public void setSectionEditable(String sectionName, boolean editable)
      Throws:
      XavaException

    • isSectionEditable

      public boolean isSectionEditable(String sectionName)
      Throws:
      XavaException

    • getKeyValuesWithValue

      public Map<String,Object> getKeyValuesWithValue()
      Excludes those values that are null, zero or empty string.
      Throws:
      XavaException

    • getKeyValues

      public Map<String,Object> getKeyValues()
      Throws:
      XavaException

    • getMembersNamesWithHidden

      public Map<String,Object> getMembersNamesWithHidden()
      Throws:
      XavaException

    • getMembersNames

      public Map<String,Object> getMembersNames()
      Throws:
      XavaException

    • getCalculatedPropertiesNames

      public Map<String,Object> getCalculatedPropertiesNames()
      Throws:
      XavaException

    • getCollectionTab

      public Tab getCollectionTab()
      Tab used for manage the data of this collection.

      This view must represents a collection in order to call this method.

      Throws:
      XavaException

    • getMetaCollection

      public MetaCollection getMetaCollection()
      Meta data about the collection, only if this view represents a collection.

      Throws:
      XavaException
      Since:
      4m6

    • getCollectionValues

      public List<Map<String,Object>> getCollectionValues()
      A list of all collection element when each element is a map with the values of the collection element.

      In order to call this method this view must represents a collection.

      The values only include the displayed data in the row.

      Returns:
      Of type Map. Never null.
      Throws:
      XavaException

    • getCollectionSize

      public int getCollectionSize()
      The size of the collection.

      In order to call this method this view must represents a collection.

      Throws:
      XavaException
      Since:
      4m5

    • getLabelDecoration

      public String getLabelDecoration()
      Since:
      5.9

    • getCollectionTotal

      public Object getCollectionTotal(int row, int column)
      Since:
      4.3

    • getCollectionTotal

      public Object getCollectionTotal(String qualifiedPropertyName, int index)
      Since:
      4.3

    • hasCollectionTotal

      public boolean hasCollectionTotal(int row, int column)
      Since:
      4.3

    • hasCollectionTotals

      public boolean hasCollectionTotals()
      Since:
      5.9

    • hasCollectionSum

      public boolean hasCollectionSum(int column)
      Since:
      5.9

    • getCollectionTotalsCount

      public int getCollectionTotalsCount()
      Since:
      4.3

    • getTotalProperties

      public Map<String,List<String>> getTotalProperties()
      Since:
      5.9

    • addCollectionSumProperty

      public void addCollectionSumProperty(String property)
      Since:
      5.9

    • removeCollectionSumProperty

      public void removeCollectionSumProperty(String property)
      Since:
      5.9

    • isCollectionTotalCapable

      public boolean isCollectionTotalCapable(int column)

    • isCollectionFixedTotal

      public boolean isCollectionFixedTotal(int column)

    • getCollectionTotalLabel

      public String getCollectionTotalLabel(int row, int column)
      Since:
      4.3

    • getCollectionTotalPropertyName

      public String getCollectionTotalPropertyName(int row, int column)

    • isCollectionTotalEditable

      public boolean isCollectionTotalEditable(int row, int column)

    • getCollectionSelectedValues

      public List<Map<String,Object>> getCollectionSelectedValues()
      A list of selected collection element when each element is a map with the values of the collection element.

      In order to call this method this view must represents a collection.

      The values only include the displayed data in the row.

      Returns:
      Of type Map. Never null.
      Throws:
      XavaException

    • getCollectionObjects

      public List<Object> getCollectionObjects()
      A list of all objects (POJOs or EntityBeans) in the collection.

      In order to call this method this view must represents a collection.

      Generally the objects are POJOs, although if you use EJBPersistenceProvider the they will be EntityBeans (of EJB2).

      Returns:
      Never null.
      Throws:
      XavaException

    • getCollectionSelectedObjects

      public List<Object> getCollectionSelectedObjects()
      A list of selected objects (POJOs or EntityBeans) in the collection.

      In order to call this method this view must represents a collection.

      Generally the objects are POJOs, although if you use EJBPersistenceProvider the they will be EntityBeans (of EJB2).

      Returns:
      Never null.
      Throws:
      XavaException

    • isCollectionFromModel

      public boolean isCollectionFromModel()
      If the collection data is obtained from the model collection directly.

      If not is obtained from model usually a Tab is used to get the data.
      In order to call this method this view must represents a collection.

      Throws:
      XavaException
      Since:
      5.3

    • isCollectionCalculated

      @Deprecated public boolean isCollectionCalculated()
      Deprecated.
      Since 5.3, use isCollectionFromModel() instead.
      If the collection represents by this view is calculated.

      In order to call this method this view must represents a collection.

      Throws:
      XavaException

    • getMembersNamesWithoutSectionsAndCollections

      public Collection<String> getMembersNamesWithoutSectionsAndCollections()
      Throws:
      XavaException

    • reset

      public void reset()
      Clear all data and set the default values.
      Throws:
      XavaException

    • getBaseModelName

      public String getBaseModelName()
      If this view represent a polymorphic model, this method return the base class of the hierarchy.

      It can return just modelName.

      Since:
      4.5.1

    • clear

      public void clear()
      Clear all displayed data.
      Throws:
      XavaException

    • isKeyEditable

      public boolean isKeyEditable()

    • setKeyEditable

      public void setKeyEditable(boolean b)
      Throws:
      XavaException

    • isEditable

      public boolean isEditable(MetaProperty metaProperty)
      If at this moment is editable.

    • isEditable

      public boolean isEditable(MetaReference metaReference)
      If at this moment is editable.

    • isEditable

      public boolean isEditable(String member)
      Throws:
      XavaException

    • setEditable

      public void setEditable(String name, boolean editable)
      To make an element of the user interface editable or not editable.
      You can use it for properties, references (since v5.5) and collections (since v5.5). The name of the member can be qualified (since v6.2).
      Parameters:
      name - Name (can be qualified) of the property, reference or section
      editable - true to make it editable, false to make it read only
      Throws:
      XavaException

    • isEditable

      public boolean isEditable()

    • setEditable

      public void setEditable(boolean b)
      Throws:
      XavaException

    • getModelName

      public String getModelName()

    • setModelName

      public void setModelName(String newModel)

    • assignValuesToWebView

      public void assignValuesToWebView()

    • throwsPropertyChanged

      public boolean throwsPropertyChanged(MetaProperty p)

    • throwsPropertyChanged

      public boolean throwsPropertyChanged(String propertyName)
      Throws:
      XavaException

    • isFirstPropertyAndViewHasNoKeys

      public boolean isFirstPropertyAndViewHasNoKeys(MetaProperty pr)
      Throws:
      XavaException

    • hasKeyProperties

      public boolean hasKeyProperties()
      Throws:
      XavaException

    • findObject

      public void findObject() throws Exception
      Using the key values loaded in the view search the rest of the data from persistent storage and fill the view.
      Throws:
      Exception

    • findObject

      public boolean findObject(MetaProperty changedProperty) throws Exception
      Using the key values loaded in the view search the rest of the data from persistent storage and fill the view.
      Parameters:
      changedProperty - Property which change produces the search.
      Returns:
      true if the object is found
      Throws:
      Exception

    • findObject

      public boolean findObject(MetaProperty changedProperty, Map<String,Object> extraKeysForSearchingReference) throws Exception
      Using the key values loaded in the view and the parameter map to search from persistent storage and fill the view.
      Parameters:
      changedProperty - Property which change produces the search.
      Returns:
      true if the object is found
      Throws:
      Exception
      Since:
      7.4.1

    • refresh

      public void refresh()
      Refresh the displayed data from database.

    • getModel

      public Object getModel()
      The model object attached to this view using setModel(Object model).

      If there is no model attached, that is the setModel() method has not been called on this View, it returns null. If you want to get the view data as an entity even if you have not attached a model to it before, use the getEntity() method instead. The model is not updated automatically from view data you have to call updateModelFromView() for that.

      Throws:
      XavaException
      Since:
      4.6

    • updateModelFromView

      public void updateModelFromView()
      Update the model object set with setModel() from data in the view.

      If model is null does nothing.

      Since:
      5.8

    • setModel

      public void setModel(Object model)
      The view will be populate with data from the model object, and the model object is attached to the view.

      You can even assign a model of different type of the current one and the view will change its shape.

      Since:
      4.6

    • getEntity

      public Object getEntity() throws Exception
      Entity associated to the current view.

      Throws:
      Exception

    • getPropertiesNamesFromStereotypesList

      public Collection<String> getPropertiesNamesFromStereotypesList(String stereotypesList)
      Parameters:
      stereotypesList - Comma separated
      Throws:
      XavaException

    • getMetaProperties

      public List<MetaProperty> getMetaProperties()
      Throws:
      XavaException

    • getMetaProperty

      public MetaProperty getMetaProperty(String name)
      Throws:
      XavaException

    • getMetaReference

      public MetaReference getMetaReference(String name)
      Throws:
      XavaException

    • getMetaPropertiesList

      public List<MetaProperty> getMetaPropertiesList()
      Throws:
      XavaException

    • getKeyPropertiesOfReferencesEntity

      public List<MetaProperty> getKeyPropertiesOfReferencesEntity()
      Since:
      7.4.4

    • setMetaPropertiesList

      public void setMetaPropertiesList(List<MetaProperty> metaProperties)
      Throws:
      XavaException

    • getPropertiesNamesFromPropertiesList

      public Collection<String> getPropertiesNamesFromPropertiesList(String propertiesList)
      Parameters:
      propertiesList - Properties names comma separated
      Throws:
      XavaException

    • getViewName

      public String getViewName()

    • setViewName

      public void setViewName(String newView)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isSubview

      public boolean isSubview()

    • setSubview

      public void setSubview(boolean b)

    • isRepresentsAggregate

      public boolean isRepresentsAggregate()

    • setRepresentsAggregate

      public void setRepresentsAggregate(boolean b)

    • getSearchAction

      public String getSearchAction()
      Throws:
      XavaException

    • isRepresentsCollection

      public boolean isRepresentsCollection()

    • isRepresentsSortableCollection

      public boolean isRepresentsSortableCollection()
      Since:
      5.6.1

    • setRepresentsCollection

      public void setRepresentsCollection(boolean b)

    • displayDetailInCollection

      public boolean displayDetailInCollection(String collectionName)
      Throws:
      XavaException

    • isCollectionDetailVisible

      public boolean isCollectionDetailVisible()

    • setCollectionDetailVisible

      public void setCollectionDetailVisible(boolean b)

    • getErrors

      public Messages getErrors()

    • getMessages

      public Messages getMessages()

    • setErrors

      public void setErrors(Messages messages)

    • setMessages

      public void setMessages(Messages messages)
      Throws:
      XavaException

    • getRequest

      public jakarta.servlet.http.HttpServletRequest getRequest()

    • setRequest

      public void setRequest(jakarta.servlet.http.HttpServletRequest request)
      Throws:
      XavaException

    • setModuleManager

      public void setModuleManager(ModuleManager moduleManager)
      Since:
      7.7

    • displayAsDescriptionsList

      public boolean displayAsDescriptionsList(MetaReference ref)
      Throws:
      XavaException

    • displayAsDescriptionsListAndReferenceView

      public boolean displayAsDescriptionsListAndReferenceView(MetaReference ref)
      Throws:
      XavaException

    • getDescriptionPropertyInDescriptionsList

      public String getDescriptionPropertyInDescriptionsList(MetaReference ref)
      Throws:
      XavaException

    • getDescriptionPropertiesInDescriptionsList

      public String getDescriptionPropertiesInDescriptionsList(MetaReference ref)
      Throws:
      XavaException

    • throwsReferenceChanged

      public boolean throwsReferenceChanged(MetaReference ref)
      Throws:
      XavaException

    • getParameterValuesPropertiesInDescriptionsList

      public String getParameterValuesPropertiesInDescriptionsList(MetaReference ref)
      Throws:
      XavaException

    • getFilterInDescriptionsList

      public String getFilterInDescriptionsList(MetaReference ref)
      Throws:
      XavaException
      Since:
      6.4

    • getConditionInDescriptionsList

      public String getConditionInDescriptionsList(MetaReference ref)
      Throws:
      XavaException

    • getOrderInDescriptionsList

      public String getOrderInDescriptionsList(MetaReference ref)
      Throws:
      XavaException

    • isOrderByKeyInDescriptionsList

      public boolean isOrderByKeyInDescriptionsList(MetaReference ref)
      Throws:
      XavaException

    • isCreateNewForReference

      public boolean isCreateNewForReference(MetaReference ref)
      Throws:
      XavaException

    • isModifyForReference

      public boolean isModifyForReference(MetaReference ref)
      Throws:
      XavaException

    • isSearchForReference

      public boolean isSearchForReference(MetaReference ref)
      Throws:
      XavaException

    • getNewActionForReference

      public String getNewActionForReference(MetaReference ref)
      Throws:
      XavaException
      Since:
      7.7

    • getEditActionForReference

      public String getEditActionForReference(MetaReference ref)
      Throws:
      XavaException
      Since:
      7.7

    • isCreateNew

      public boolean isCreateNew()
      Throws:
      XavaException

    • isModify

      public boolean isModify()
      Throws:
      XavaException

    • getNewAction

      public String getNewAction()
      Throws:
      XavaException
      Since:
      7.7

    • getEditAction

      public String getEditAction()
      Throws:
      XavaException
      Since:
      7.7

    • isSearch

      public boolean isSearch()
      Throws:
      XavaException

    • isLastSearchKey

      public boolean isLastSearchKey(String propertyName)
      Throws:
      XavaException

    • isLastSearchKey

      public boolean isLastSearchKey(MetaProperty p)
      Throws:
      XavaException

    • isRepresentsElementCollection

      public boolean isRepresentsElementCollection()

    • getSearchKeyName

      public String getSearchKeyName()
      Since:
      5.7.1

    • isHidden

      public boolean isHidden(String name)

    • setHidden

      public void setHidden(String name, boolean hidden)
      To hide/show an element of the user interface.
      You can hide properties, references, collections, groups and sections.
      If the name of a member and its container section or group is the same, the container section or group will be hidden. If you want to hide the member inside you should rename the group or section. The name of the member can be qualified (since v6.2).
      Parameters:
      name - Name (can be qualified) of the member, group or section
      hidden - true to hide, false to show
      Throws:
      XavaException

    • getParent

      public View getParent()

    • getRoot

      public View getRoot()

    • getCollectionRootOrRoot

      public View getCollectionRootOrRoot()
      Since:
      5.8.1

    • hasSections

      public boolean hasSections()
      Throws:
      XavaException

    • displayAsDescriptionsListAndReferenceView

      public boolean displayAsDescriptionsListAndReferenceView()

    • displayReferenceWithNoFrameEditor

      public boolean displayReferenceWithNoFrameEditor(MetaReference ref)

    • displayWithFrame

      public boolean displayWithFrame()

    • displayReferenceWithNotCompositeEditor

      public boolean displayReferenceWithNotCompositeEditor(MetaReference ref)

    • getSections

      public List<MetaView> getSections()
      Throws:
      XavaException

    • getSectionView

      public View getSectionView(int index)
      Throws:
      XavaException

    • isSection

      public boolean isSection()

    • setSection

      public void setSection(boolean b)

    • getActiveSection

      public int getActiveSection()
      Throws:
      XavaException

    • setActiveSection

      public void setActiveSection(int i)

    • getCollectionEditingRow

      public int getCollectionEditingRow()

    • setCollectionEditingRow

      public void setCollectionEditingRow(int i)

    • getMemberName

      public String getMemberName()

    • setMemberName

      public void setMemberName(String string)
      Throws:
      XavaException

    • isCollectionMembersEditables

      public boolean isCollectionMembersEditables()

    • setCollectionMembersEditables

      public void setCollectionMembersEditables(boolean b)

    • isCollectionSortable

      public boolean isCollectionSortable()

    • isCollectionEditable

      public boolean isCollectionEditable()

    • setCollectionEditable

      public void setCollectionEditable(boolean b)

    • isRepresentsEntityReference

      public boolean isRepresentsEntityReference()

    • setRepresentsEntityReference

      public void setRepresentsEntityReference(boolean b)

    • getActionsNamesDetail

      public Collection<String> getActionsNamesDetail()
      Has sense if the subview represents a collection, although always works.

    • setActionsNamesDetail

      public void setActionsNamesDetail(Collection<String> collection)
      Has sense if the subview represents a collection, although always works.

    • addDetailAction

      public void addDetailAction(String qualifiedActionName)
      Has sense if the subview represents a collection, although always works.
      Parameters:
      qualifiedActionName - Qualified name (controller.action) as in controllers.xml

    • removeDetailAction

      public void removeDetailAction(String qualifiedActionName)
      Has sense if the subview represents a collection, although always works.
      Parameters:
      qualifiedActionName - Qualified name (controller.action) as in controllers.xml

    • addListAction

      public void addListAction(String qualifiedActionName)
      Has sense if the subview represents a collection, although always works.
      Parameters:
      qualifiedActionName - Qualified name (controller.action) as in controllers.xml

    • addRowAction

      public void addRowAction(String qualifiedActionName)

    • removeRowAction

      public void removeRowAction(String qualifiedActionName)

    • removeListAction

      public void removeListAction(String qualifiedActionName)
      Has sense if the subview represents a collection, although always works.
      Parameters:
      qualifiedActionName - Qualified name (controller.action) as in controllers.xml

    • getRowActionsNames

      public Collection<String> getRowActionsNames()

    • isRowActionHaveIcon

      public boolean isRowActionHaveIcon(Collection rowActions)

    • removeUnavailableActionFromRow

      public Collection<String> removeUnavailableActionFromRow(Collection<String> rowActions, String actionArgv)

    • getActionsNamesList

      public Collection<String> getActionsNamesList()

    • getSubcontrollersNamesList

      public Collection<String> getSubcontrollersNamesList()

    • hasListActions

      public boolean hasListActions()

    • setActionsNamesList

      public void setActionsNamesList(Collection<String> collection)

    • setSubcontrollersNamesList

      public void setSubcontrollersNamesList(Collection<String> collection)

    • setActionsNamesRow

      public void setActionsNamesRow(Collection<String> collection)

    • getActionsNamesRow

      public Collection<String> getActionsNamesRow()

    • getActionsNamesForProperty

      public Collection<String> getActionsNamesForProperty(MetaProperty p, boolean editable)
      Throws:
      XavaException

    • getActionsNamesForReference

      public Collection<String> getActionsNamesForReference(MetaReference ref, boolean editable)
      Throws:
      XavaException

    • getActionsNamesForReference

      public Collection<String> getActionsNamesForReference(boolean editable)
      If this is a view that represents a reference
      Throws:
      XavaException

    • getLabelFormatForProperty

      public int getLabelFormatForProperty(MetaProperty p)
      Throws:
      XavaException

    • getLabelFormatForReference

      public int getLabelFormatForReference(MetaReference ref)
      Throws:
      XavaException

    • isSimple

      public boolean isSimple()
      To determine what type of layout to do with flowLayout activated.
      Since:
      5.7

    • isFlowLayout

      public boolean isFlowLayout()

    • getDisplaySizeForProperty

      public int getDisplaySizeForProperty(MetaProperty p)
      Throws:
      XavaException

    • getDisplaySizeForProperty

      public int getDisplaySizeForProperty(String propertyName)
      Throws:
      XavaException

    • isFrame

      public boolean isFrame()
      Throws:
      XavaException

    • getFocusPropertyId

      public String getFocusPropertyId()

    • setFocus

      public void setFocus(String newFocusProperty)
      Sets the focus in the provided property

    • getEditCollectionElementAction

      public String getEditCollectionElementAction()

    • getViewCollectionElementAction

      public String getViewCollectionElementAction()

    • setEditCollectionElementAction

      public void setEditCollectionElementAction(String editCollectionElementAction)

    • setViewCollectionElementAction

      public void setViewCollectionElementAction(String viewCollectionElementAction)

    • recalculateProperties

      public void recalculateProperties()

    • getLabelFor

      public String getLabelFor(MetaMember p)
      Throws:
      XavaException

    • setLabelId

      public void setLabelId(String property, String id)
      Parameters:
      property - Since v4.2 can qualified. Since v6.4 can be a group or section name
      id - Id of the label from i18n files

    • isOnlyThrowsOnChange

      public boolean isOnlyThrowsOnChange()

    • setOnlyThrowsOnChange

      public void setOnlyThrowsOnChange(boolean onlyThrowsOnChange)

    • setCollectionColumnWidth

      public void setCollectionColumnWidth(int columnIndex, int width)

    • getCollectionColumnWidth

      public int getCollectionColumnWidth(int columnIndex)

    • getHideCollectionElementAction

      public String getHideCollectionElementAction()

    • setHideCollectionElementAction

      public void setHideCollectionElementAction(String hideCollectionElementAction)

    • getAddCollectionElementAction

      public String getAddCollectionElementAction()

    • getNewCollectionElementAction

      public String getNewCollectionElementAction()

    • setNewCollectionElementAction

      public void setNewCollectionElementAction(String newCollectionElementAction)

    • getRemoveCollectionElementAction

      public String getRemoveCollectionElementAction()

    • setRemoveCollectionElementAction

      public void setRemoveCollectionElementAction(String removeCollectionElementAction)

    • getRemoveSelectedCollectionElementsAction

      public String getRemoveSelectedCollectionElementsAction()

    • setRemoveSelectedCollectionElementsAction

      public void setRemoveSelectedCollectionElementsAction(String removeSelectedCollectionElementAction)

    • getDeleteSelectedCollectionElementsAction

      public String getDeleteSelectedCollectionElementsAction()

    • setDeleteSelectedCollectionElementsAction

      public void setDeleteSelectedCollectionElementsAction(String deleteSelectedCollectionElementsAction)

    • getSaveCollectionElementAction

      public String getSaveCollectionElementAction()

    • setSaveCollectionElementAction

      public void setSaveCollectionElementAction(String saveCollectionElementAction)

    • getPreviousCollectionElementAction

      public String getPreviousCollectionElementAction()

    • setPreviousCollectionElementAction

      public void setPreviousCollectionElementAction(String previousCollectionElementAction)

    • getNextCollectionElementAction

      public String getNextCollectionElementAction()

    • setNextCollectionElementAction

      public void setNextCollectionElementAction(String nextCollectionElementAction)

    • isAlignedByColumns

      public boolean isAlignedByColumns()
      Throws:
      XavaException
      Since:
      5.7

    • putObject

      public void putObject(String name, Object object)
      Associates an arbitrary object to this view.

      This object is not used by the view for any purpose, this is only a convenience method for developer.

      Parameters:
      name - The id to retrieve the object later.
      object - The object to associate.

    • getObject

      public Object getObject(String name)
      Retrieve an object associated to this view.

      The object have to be associated to this view using @link #putObject(String, Object)

      Parameters:
      name - Name of the object to retrieve.
      Returns:
      The object, or null if it is not found.

    • removeObject

      public void removeObject(String name)
      Remove from this view an object previously associated with @link #putObject(String, Object)
      Parameters:
      name - Name of the object to remove.

    • getChangedPropertiesActionsAndReferencesWithNotCompositeEditor

      public Map<String,View> getChangedPropertiesActionsAndReferencesWithNotCompositeEditor()
      Qualified ids of the properties and references with not composite editor (that includes descriptions lists) changed in this request.

      This does not have a valid value until the end of the request, and it's intended to be used from the AJAX code in order to determine what to refresh.

      Returns:
      In each entry the key is the qualified id and value the container view

    • hasEditableChanged

      public boolean hasEditableChanged()
      If the state of the editable has changed in the last request.

      This does not have a valid value until the end of the request, and it's intended to be used from the AJAX code in order to determine what to refresh.

    • hasKeyEditableChanged

      public boolean hasKeyEditableChanged()
      If the state of the keyEditable has changed in the last request.

      This does not have a valid value until the end of the request, and it's intended to be used from the AJAX code in order to determine what to refresh.

    • descriptionsListsRefreshed

      public boolean descriptionsListsRefreshed()

    • refreshDescriptionsLists

      public void refreshDescriptionsLists()
      Refresh the displayed data of all the references as descriptions list of this view from database.

    • refreshCollections

      public void refreshCollections()
      Refreshs the displayed data of all the collections of this view from database.

    • getChangedLabels

      public Map<String,String> getChangedLabels()
      Qualified ids of the member whose labels have changed in this request.

      This does not have a valid value until the end of the request, and it's intended to be used from the AJAX code in order to determine what to refresh.

      Returns:
      In each entry the key is the qualified id and value of the new label

    • getChangedCollections

      public Map<String,View> getChangedCollections()
      Qualified ids of the collections changed in this request.

      This does not have a valid value until the end of the request, and it's intended to be used from the AJAX code in order to determine what to refresh.

      Returns:
      In each entry the key is the qualified id and value the container view

    • hasChangedCollections

      public boolean hasChangedCollections()
      Since:
      7.6.3

    • getChangedCollectionSizesInSections

      public Map<View,Integer> getChangedCollectionSizesInSections()
      Views of sections that have collection size in the label, with the collection size.

      This does not have a valid value until the end of the request, and it's intended to be used from the AJAX code in order to determine what to refresh.

      Since:
      5.9

    • getChangedCollectionsTotals

      public Map<String,View> getChangedCollectionsTotals()
      Qualified ids of the collections totals changed in this request.

      This does not have a valid value until the end of the request, and it's intended to be used from the AJAX code in order to determine what to refresh.

      Returns:
      In each entry the key is the qualified id and value the container view
      Since:
      5.1

    • getChangedCollectionsSelectedRows

      public Map<String,int[]> getChangedCollectionsSelectedRows()
      Indices of selected rows of collections that has changed their selected rows but not their content.

      This does not have a valid value until the end of the request, and it's intended to be used from the AJAX code in order to determine what to refresh.

      Since:
      4.5

    • setViewObject

      public void setViewObject(String viewObject)
      The name of this view as session object.

    • getViewObject

      public String getViewObject()
      The name of this view as session object.

    • setPropertyPrefix

      public void setPropertyPrefix(String propertyPrefix)
      Prefix used in HTML code for the properties of this view.

    • getPropertyPrefix

      public String getPropertyPrefix()
      Prefix used in HTML code for the properties of this view.

    • resetCollectionsCache

      public void resetCollectionsCache()

    • getChangedSectionsView

      public View getChangedSectionsView()

    • isReloadNeeded

      public boolean isReloadNeeded()

    • getQualifiedNameForDisplayedPropertyOrReferenceWithNotCompositeEditor

      public String getQualifiedNameForDisplayedPropertyOrReferenceWithNotCompositeEditor(String name)
      If the property or the reference with not composite (single) editor is displayed in this moment then the qualified name (in ModelName.memberName format) is returned.

      Parameters:
      name - Can be the simple or the qualified name of the member
      Returns:
      The qualified name in form ModelName.memberName or null if is not a property or a reference with not composite editor.

    • propertyHasActions

      public boolean propertyHasActions(String name)
      If the property has actions associated to it.

      If the actions are showed or not in this moment has no effect in the result.

    • propertyHasActions

      public boolean propertyHasActions(MetaProperty p)
      If the property has actions associated to it.

      If the actions are showed or not in this moment has no effect in the result.

    • getOnSelectCollectionElementAction

      public String getOnSelectCollectionElementAction()

    • setOnSelectCollectionElementAction

      public void setOnSelectCollectionElementAction(String onSelectCollectionElementAction)

    • isVariousCollectionsInSameLine

      public boolean isVariousCollectionsInSameLine(MetaMember metaMember)

    • isVariousMembersInSameLine

      public boolean isVariousMembersInSameLine(MetaMember metaMember)

    • isFirstInLine

      public boolean isFirstInLine(MetaMember metaMember)

    • isDefaultListActionsForCollectionsIncluded

      public boolean isDefaultListActionsForCollectionsIncluded()

    • setDefaultListActionsForCollectionsIncluded

      public void setDefaultListActionsForCollectionsIncluded(boolean defaultListActionsForCollectionsIncluded)

    • isDefaultRowActionsForCollectionsIncluded

      public boolean isDefaultRowActionsForCollectionsIncluded()

    • setDefaultRowActionsForCollectionsIncluded

      public void setDefaultRowActionsForCollectionsIncluded(boolean defaultRowActionsForCollectionsIncluded)

    • setTitleId

      public void setTitleId(String id, Object... arguments)
      Since:
      4m1

    • getTitle

      public String getTitle()
      Since:
      4m1

    • setTitle

      public void setTitle(String title)
      Since:
      4m1

    • getLabelStyleForProperty

      public String getLabelStyleForProperty(MetaProperty p)
      Throws:
      XavaException

    • getLabelStyleForReference

      public String getLabelStyleForReference(MetaReference ref)
      Throws:
      XavaException

    • setCollapsed

      public void setCollapsed(String name, boolean collapsed)

    • isCollapsed

      public boolean isCollapsed(String name)

    • setFrameClosed

      public void setFrameClosed(String frameId, boolean frameClosed)

    • isFrameClosed

      public boolean isFrameClosed(String frameId)

    • addActionForProperty

      public void addActionForProperty(String property, String qualifiedActionName)
      Add an action to the property.

      The action will be show even if the view or the property is not editable.

      Throws:
      XavaException
      Since:
      4.5

    • removeActionForProperty

      public void removeActionForProperty(String property, String qualifiedActionName)
      Remove an action to the property.

      Only the actions added with addActionForProperty() can be removed.

      Throws:
      XavaException
      Since:
      4.5

    • propertyHasChangedActions

      public boolean propertyHasChangedActions(String property)

    • collectionDeselectAll

      public void collectionDeselectAll()
      Deselects all items in collection

    • deselectCollection

      public void deselectCollection(String deselect)
      Parameters:
      as - 'ox_OpenXavaTest_CarrierWithCollectionsTogether__xava_collectionTab_fellowCarriers:1,3,2'

    • moveCollectionElement

      public void moveCollectionElement(int from, int to) throws Exception
      Throws:
      Exception

    • reloadMetaModel

      public void reloadMetaModel()
      Since:
      5.6

    • setAddCollectionElementAction

      public void setAddCollectionElementAction(String addCollectionElementAction)

    • isPropertyUsedInCalculation

      public boolean isPropertyUsedInCalculation(String qualifiedName)

    • getDependentCalculationPropertiesNamesFor

      public Collection<String> getDependentCalculationPropertiesNamesFor(String qualifiedName)

    • addValidValue

      public void addValidValue(String property, Object value, String label)
      Add a new valid value to a property, generating a combo in the UI for this property. For example, for a simple property like this: 
       private String color;
      You can add a combo programmatically in this way: 
       getView().addValidValue("color", "wht", "White");
 getView().addValidValue("color", "blk", "Black");
      This creates a combo for color property with two values wht with label White and blk with label Black.
      Parameters:
      property - The name of the property. It has to be in the model, but not in the view in this moment.
      value - The value that will be store in the property, the type has to match with the property type.
      label - The label shown in the combo.
      Since:
      5.8

    • removeValidValue

      public void removeValidValue(String property, Object value)
      Removed a valid value previously added with addValidValue().
      Parameters:
      property - The name of the property. It has to be in the model, but not in the view in this moment.
      value - The valid value stored in the property that we want to remove, the type has to match with the property type.
      Since:
      5.8

    • clearValidValues

      public void clearValidValues(String property)
      Remove all the valid values previously added with addValidValue().
      The property is still displayed as a combo with a sigle blank option.
      Parameters:
      property - The name of the property. It has to be in the model, but not in the view in this moment.
      Since:
      6.3

    • disableValidValues

      public void disableValidValues(String property)
      Remove all the valid values previously added with addValidValue() and disable the combo.
      After calling the method the property is displayed as regular text field, no longer as a combo.
      Parameters:
      property - The name of the property. It has to be in the model, but not in the view in this moment.
      Since:
      6.3

    • removeBlankValidValue

      public void removeBlankValidValue(String property)
      Removed the blank option of a valid value created with addValidValue(). By default using addValidValues() creates a combo that includes a blank option. This method removes that blank option.
      Parameters:
      property - The name of the property. It has to be in the model, but not in the view in this moment.
      Since:
      6.3

    • hasBlankValidValue

      public boolean hasBlankValidValue(String property)
      If the property with valid values added via addValidValue() has a blank option.

      Parameters:
      property - The name of the property. It has to be in the model, but not in the view in this moment.
      Since:
      6.3

    • hasValidValues

      public boolean hasValidValues(String property)
      If the property has valid values associated.

      Valid values are added via addValidValue().

      Parameters:
      property - The name of the property. It has to be in the model, but not in the view in this moment.
      Since:
      5.8

    • getValidValues

      public Map<Object,String> getValidValues(String property)
      List of valid values associated to the property.

      Valid values are added via addValidValue().

      Parameters:
      property - The name of the property. It has to be in the model, but not in the view in this moment.
      Returns:
      A map with value/label pairs.
      Since:
      5.8

    • setDescriptionsListCondition

      public void setDescriptionsListCondition(String referenceName, String condition)
      Throws:
      XavaException
      Since:
      5.8

    • getDescriptionsListCondition

      public String getDescriptionsListCondition(String referenceName)
      Throws:
      XavaException
      Since:
      5.8

    • isRepresentsEntityCollection

      public boolean isRepresentsEntityCollection()
      Throws:
      XavaException
      Since:
      7.4

    • setStyle

      public void setStyle(String propertyName, String style)
      Set the CSS style class for the specified property.

      The style is the name of a CSS class that will wrap the editor of the property.

      Parameters:
      propertyName - Can be qualified, for example "address.street".
      style - A string with the CSS class name. Can be null to remove the style.
      Since:
      7.7

    • getStyle

      public String getStyle(String propertyName)
      The CSS style class for the specified property.

      Parameters:
      propertyName - Can be qualified, for example "address.street".
      Returns:
      The CSS class name, or null if no style has been set.
      Since:
      7.7

    • clearStyles

      public void clearStyles()
      Remove all CSS styles set with setStyle(String, String).

      Since:
      7.7