View (OpenXava 6.3 API)

java.lang.Object
- org.openxava.view.View

All Implemented Interfaces:

java.io.Serializable
```
public class View
extends java.lang.Object
implements java.io.Serializable
```
Session object to manage a view based in maps, hence suitable for OpenXava

Author:

Javier Paniza

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

View()

Constructors
Constructor and Description
`View()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addActionForProperty(java.lang.String property, java.lang.String qualifiedActionName)` Add an action to the property.
`void`	`addCollectionSumProperty(java.lang.String property)`
`void`	`addDetailAction(java.lang.String qualifiedActionName)` Has sense if the subview represents a collection, although always works.
`void`	`addListAction(java.lang.String qualifiedActionName)` Has sense if the subview represents a collection, although always works.
`void`	`addRowAction(java.lang.String qualifiedActionName)`
`void`	`addValidValue(java.lang.String property, java.lang.Object value, java.lang.String label)` Add a new valid value to a property, generating a combo in the UI for this property.
`void`	`addValues(java.util.Map values)`
`void`	`assignValuesToWebView()`
`void`	`clear()` Clear all displayed data.
`void`	`clearValidValues(java.lang.String property)` Remove all the valid values previously added with addValidValue().
`void`	`collectionDeselectAll()` Deselects all items in collection
`boolean`	`descriptionsListsRefreshed()`
`void`	`deselectCollection(java.lang.String deselect)`
`void`	`disableValidValues(java.lang.String property)` Remove all the valid values previously added with addValidValue() and disable the combo.
`boolean`	`displayAsDescriptionsList(MetaReference ref)`
`boolean`	`displayAsDescriptionsListAndReferenceView()`
`boolean`	`displayAsDescriptionsListAndReferenceView(MetaReference ref)`
`boolean`	`displayDetailInCollection(java.lang.String collectionName)`
`boolean`	`displayReferenceWithNoFrameEditor(MetaReference ref)`
`boolean`	`displayReferenceWithNotCompositeEditor(MetaReference ref)`
`boolean`	`displayWithFrame()`
`void`	`findObject()` Using the key values loaded in the view search the rest of the data from persistent storage and fill the view.
`boolean`	`findObject(MetaProperty changedProperty)` Using the key values loaded in the view search the rest of the data from persistent storage and fill the view.
`java.util.Collection`	`getActionsNamesDetail()` Has sense if the subview represents a collection, although always works.
`java.util.Collection`	`getActionsNamesForProperty(MetaProperty p, boolean editable)`
`java.util.Collection`	`getActionsNamesForReference(boolean editable)` If this is a view that represents a reference
`java.util.Collection`	`getActionsNamesForReference(MetaReference ref, boolean editable)`
`java.util.Collection`	`getActionsNamesList()`
`java.util.Collection`	`getActionsNamesRow()`
`int`	`getActiveSection()`
`java.lang.String`	`getAddCollectionElementAction()`
`java.util.Map`	`getAllValues()` Copy of all values showed in view.
`java.lang.String`	`getBaseModelName()` If this view represent a polymorphic model, this method return the base class of the hierarchy.
`java.util.Map`	`getCalculatedPropertiesNames()`
`java.util.Map<java.lang.String,View>`	`getChangedCollections()` Qualified ids of the collections changed in this request.
`java.util.Map<View,java.lang.Integer>`	`getChangedCollectionSizesInSections()` Views of sections that have collection size in the label, with the collection size.
`java.util.Map<java.lang.String,int[]>`	`getChangedCollectionsSelectedRows()` Indices of selected rows of collections that has changed their selected rows but not their content.
`java.util.Map`	`getChangedCollectionsTotals()` Qualified ids of the collections totals changed in this request.
`java.util.Map`	`getChangedLabels()` Qualified ids of the member whose labels have changed in this request.
`java.util.Map`	`getChangedPropertiesActionsAndReferencesWithNotCompositeEditor()` Qualified ids of the properties and references with not composite editor (that includes descriptions lists) changed in this request.
`View`	`getChangedSectionsView()`
`int`	`getCollectionColumnWidth(int columnIndex)`
`int`	`getCollectionEditingRow()`
`java.util.List`	`getCollectionObjects()` A list of all objects (POJOs or EntityBeans) in the collection.
`View`	`getCollectionRootOrRoot()`
`java.util.List`	`getCollectionSelectedObjects()` A list of selected objects (POJOs or EntityBeans) in the collection.
`java.util.List`	`getCollectionSelectedValues()` A list of selected collection element when each element is a map with the values of the collection element.
`int`	`getCollectionSize()` The size of the collection.
`Tab`	`getCollectionTab()` `Tab` used for manage the data of this collection.
`java.lang.Object`	`getCollectionTotal(int row, int column)`
`java.lang.Object`	`getCollectionTotal(java.lang.String qualifiedPropertyName, int index)`
`java.lang.String`	`getCollectionTotalLabel(int row, int column)`
`java.lang.String`	`getCollectionTotalPropertyName(int row, int column)`
`int`	`getCollectionTotalsCount()`
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getCollectionValues()` A list of all collection element when each element is a map with the values of the collection element.
`java.lang.String`	`getConditionInDescriptionsList(MetaReference ref)`
`java.lang.Object`	`getDefaultValueInElementCollection(java.lang.String qualifiedPropertyName)`
`java.lang.String`	`getDependentCalculationPropertyNameFor(java.lang.String qualifiedName)`
`java.lang.String`	`getDescriptionPropertiesInDescriptionsList(MetaReference ref)`
`java.lang.String`	`getDescriptionPropertyInDescriptionsList(MetaReference ref)`
`java.lang.String`	`getDescriptionsListCondition(java.lang.String referenceName)`
`int`	`getDisplaySizeForProperty(MetaProperty p)`
`int`	`getDisplaySizeForProperty(java.lang.String propertyName)`
`java.lang.String`	`getEditCollectionElementAction()`
`java.lang.Object`	`getEntity()` Entity associated to the current view.
`Messages`	`getErrors()`
`java.lang.String`	`getFocusPropertyId()`
`View`	`getGroupView(java.lang.String name)`
`java.lang.String`	`getHideCollectionElementAction()`
`java.util.Map`	`getKeyValues()`
`java.util.Map`	`getKeyValuesWithValue()` Excludes those values that are null, zero or empty string.
`java.lang.String`	`getLabelDecoration()`
`java.lang.String`	`getLabelFor(MetaMember p)`
`int`	`getLabelFormatForProperty(MetaProperty p)`
`int`	`getLabelFormatForReference(MetaReference ref)`
`java.lang.String`	`getLabelStyleForProperty(MetaProperty p)`
`java.lang.String`	`getLabelStyleForReference(MetaReference ref)`
`java.lang.String`	`getMemberName()`
`java.util.Map`	`getMembersNames()`
`java.util.Map`	`getMembersNamesWithHidden()`
`java.util.Collection`	`getMembersNamesWithoutSectionsAndCollections()`
`Messages`	`getMessages()`
`MetaCollection`	`getMetaCollection()` Meta data about the collection, only if this view represents a collection.
`java.util.Collection<MetaMember>`	`getMetaMembers()`
`MetaModel`	`getMetaModel()`
`java.util.List<MetaProperty>`	`getMetaProperties()`
`java.util.List<MetaProperty>`	`getMetaPropertiesList()`
`MetaProperty`	`getMetaProperty(java.lang.String name)`
`MetaReference`	`getMetaReference(java.lang.String name)`
`MetaView`	`getMetaView()`
`java.lang.Object`	`getModel()` The model object attached to this view using `setModel(Object model)`.
`java.lang.String`	`getModelName()`
`java.lang.String`	`getNewCollectionElementAction()`
`java.lang.Object`	`getObject(java.lang.String name)` Retrieve an object associated to this view.
`java.lang.String`	`getOnSelectCollectionElementAction()`
`java.lang.String`	`getOrderInDescriptionsList(MetaReference ref)`
`java.lang.String`	`getParameterValuesPropertiesInDescriptionsList(MetaReference ref)`
`View`	`getParent()`
`java.util.Collection`	`getPropertiesNamesFromPropertiesList(java.lang.String propertiesList)`
`java.util.Collection`	`getPropertiesNamesFromStereotypesList(java.lang.String stereotypesList)`
`java.lang.String`	`getPropertyPrefix()` Prefix used in HTML code for the properties of this view.
`java.lang.String`	`getQualifiedNameForDisplayedPropertyOrReferenceWithNotCompositeEditor(java.lang.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.
`java.lang.String`	`getRemoveCollectionElementAction()`
`java.lang.String`	`getRemoveSelectedCollectionElementsAction()`
`HttpServletRequest`	`getRequest()`
`View`	`getRoot()`
`java.util.Collection`	`getRowActionsNames()`
`java.lang.String`	`getSaveCollectionElementAction()`
`java.lang.String`	`getSearchAction()`
`java.lang.String`	`getSearchKeyName()`
`java.util.List`	`getSections()`
`View`	`getSectionView(int index)`
`java.util.Collection<java.lang.String>`	`getSubcontrollersNamesList()`
`View`	`getSubview(java.lang.String name)`
`java.lang.String`	`getTitle()`
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getTotalProperties()`
`java.util.Map`	`getValidValues(java.lang.String property)` List of valid values associated to the property.
`java.lang.Object`	`getValue(java.lang.String name)` A value from the property name.
`int`	`getValueInt(java.lang.String name)`
`java.util.Map`	`getValues()` Copy of the values showed in view.
`java.lang.String`	`getValueString(java.lang.String name)`
`java.lang.String`	`getViewCollectionElementAction()`
`java.lang.String`	`getViewName()`
`java.lang.String`	`getViewObject()` The name of this view as session object.
`boolean`	`hasBlankValidValue(java.lang.String property)` If the property with valid values added via addValidValue() has a blank option.
`boolean`	`hasCollectionSum(int column)`
`boolean`	`hasCollectionTotal(int row, int column)`
`boolean`	`hasCollectionTotals()`
`boolean`	`hasEditableChanged()` If the state of the `editable has changed in the last request.`
`boolean`	`hasKeyEditableChanged()` If the state of the `keyEditable has changed in the last request.`
`boolean`	`hasKeyProperties()`
`boolean`	`hasListActions()`
`boolean`	`hasSections()`
`boolean`	`hasValidValues(java.lang.String property)` If the property has valid values associated.
`boolean`	`isAlignedByColumns()`
`boolean`	`isCollapsed(java.lang.String name)`
`boolean`	`isCollectionCalculated()` Deprecated. Since 5.3, use isCollectionFromModel() instead.
`boolean`	`isCollectionDetailVisible()`
`boolean`	`isCollectionEditable()`
`boolean`	`isCollectionFixedTotal(int column)`
`boolean`	`isCollectionFromModel()` If the collection data is obtained from the model collection directly.
`boolean`	`isCollectionMembersEditables()`
`boolean`	`isCollectionSortable()`
`boolean`	`isCollectionTotalCapable(int column)`
`boolean`	`isCollectionTotalEditable(int row, int column)`
`boolean`	`isCreateNew()`
`boolean`	`isCreateNewForReference(MetaReference ref)`
`boolean`	`isDataChanged()`
`boolean`	`isDefaultListActionsForCollectionsIncluded()`
`boolean`	`isDefaultRowActionsForCollectionsIncluded()`
`boolean`	`isEditable()`
`boolean`	`isEditable(MetaProperty metaProperty)` If at this moment is editable.
`boolean`	`isEditable(MetaReference metaReference)` If at this moment is editable.
`boolean`	`isEditable(java.lang.String member)`
`boolean`	`isFirstInLine(MetaMember metaMember)`
`boolean`	`isFirstPropertyAndViewHasNoKeys(MetaProperty pr)`
`boolean`	`isFlowLayout()`
`boolean`	`isFrame()`
`boolean`	`isFrameClosed(java.lang.String frameId)`
`boolean`	`isHidden(java.lang.String name)`
`boolean`	`isKeyEditable()`
`boolean`	`isLastSearchKey(MetaProperty p)`
`boolean`	`isLastSearchKey(java.lang.String propertyName)`
`boolean`	`isMemberFromElementCollection(java.lang.String memberName)`
`boolean`	`isModify()`
`boolean`	`isModifyForReference(MetaReference ref)`
`boolean`	`isOnlyThrowsOnChange()`
`boolean`	`isOrderByKeyInDescriptionsList(MetaReference ref)`
`boolean`	`isPropertyUsedInCalculation(java.lang.String qualifiedName)`
`boolean`	`isReloadNeeded()`
`boolean`	`isRepresentsAggregate()`
`boolean`	`isRepresentsCollection()`
`boolean`	`isRepresentsElementCollection()`
`boolean`	`isRepresentsEntityReference()`
`boolean`	`isRepresentsSortableCollection()`
`boolean`	`isSearch()`
`boolean`	`isSearchForReference(MetaReference ref)`
`boolean`	`isSection()`
`boolean`	`isSectionEditable(java.lang.String sectionName)`
`boolean`	`isSimple()` To determine what type of layout to do with flowLayout activated.
`boolean`	`isSubview()`
`boolean`	`isVariousCollectionsInSameLine(MetaMember metaMember)`
`boolean`	`isVariousMembersInSameLine(MetaMember metaMember)`
`void`	`moveCollectionElement(int from, int to)`
`boolean`	`propertyHasActions(MetaProperty p)` If the property has actions associated to it.
`boolean`	`propertyHasActions(java.lang.String name)` If the property has actions associated to it.
`boolean`	`propertyHasChangedActions(java.lang.String property)`
`void`	`putObject(java.lang.String name, java.lang.Object object)` Associates an arbitrary object to this view.
`void`	`recalculateProperties()`
`void`	`refresh()` Refresh the displayed data from database.
`void`	`refreshCollections()` Refreshs the displayed data of all the collections of this view from database.
`void`	`refreshDescriptionsLists()` Refresh the displayed data of all the references as descriptions list of this view from database.
`void`	`reloadMetaModel()`
`void`	`removeActionForProperty(java.lang.String property, java.lang.String qualifiedActionName)` Remove an action to the property.
`void`	`removeBlankValidValue(java.lang.String property)` Removed the blank option of a valid value created with addValidValue().
`void`	`removeCollectionSumProperty(java.lang.String property)`
`void`	`removeDetailAction(java.lang.String qualifiedActionName)` Has sense if the subview represents a collection, although always works.
`void`	`removeListAction(java.lang.String qualifiedActionName)` Has sense if the subview represents a collection, although always works.
`void`	`removeObject(java.lang.String name)` Remove from this view an object previously associated with @link #putObject(String, Object)
`void`	`removeRowAction(java.lang.String qualifiedActionName)`
`void`	`removeValidValue(java.lang.String property, java.lang.Object value)` Removed a valid value previously added with addValidValue().
`void`	`reset()` Clear all data and set the default values.
`void`	`resetCollectionsCache()`
`void`	`setActionsNamesDetail(java.util.Collection collection)` Has sense if the subview represents a collection, although always works.
`void`	`setActionsNamesList(java.util.Collection collection)`
`void`	`setActionsNamesRow(java.util.Collection collection)`
`void`	`setActiveSection(int i)`
`void`	`setAddCollectionElementAction(java.lang.String addCollectionElementAction)`
`void`	`setCollapsed(java.lang.String name, boolean collapsed)`
`void`	`setCollectionColumnWidth(int columnIndex, int width)`
`void`	`setCollectionDetailVisible(boolean b)`
`void`	`setCollectionEditable(boolean b)`
`void`	`setCollectionEditingRow(int i)`
`void`	`setCollectionMembersEditables(boolean b)`
`void`	`setDefaultListActionsForCollectionsIncluded(boolean defaultListActionsForCollectionsIncluded)`
`void`	`setDefaultRowActionsForCollectionsIncluded(boolean defaultRowActionsForCollectionsIncluded)`
`void`	`setDescriptionsListCondition(java.lang.String referenceName, java.lang.String condition)`
`void`	`setEditable(boolean b)`
`void`	`setEditable(java.lang.String name, boolean editable)` To make an element of the user interface editable or not editable.
`void`	`setEditCollectionElementAction(java.lang.String editCollectionElementAction)`
`void`	`setErrors(Messages messages)`
`void`	`setFocus(java.lang.String newFocusProperty)` Sets the focus in the provided property
`void`	`setFrameClosed(java.lang.String frameId, boolean frameClosed)`
`void`	`setHidden(java.lang.String name, boolean hidden)` To hide/show an element of the user interface.
`void`	`setHideCollectionElementAction(java.lang.String hideCollectionElementAction)`
`void`	`setKeyEditable(boolean b)`
`void`	`setLabelId(java.lang.String propertyName, java.lang.String id)`
`void`	`setMemberName(java.lang.String string)`
`void`	`setMessages(Messages messages)`
`void`	`setMetaMembers(java.util.Collection metaMembers)`
`void`	`setModel(java.lang.Object model)` The view will be populate with data from the model object, and the model object is attached to the view.
`void`	`setModelName(java.lang.String newModel)`
`void`	`setNewCollectionElementAction(java.lang.String newCollectionElementAction)`
`void`	`setOnlyThrowsOnChange(boolean onlyThrowsOnChange)`
`void`	`setOnSelectCollectionElementAction(java.lang.String onSelectCollectionElementAction)`
`static void`	`setPolisher(java.lang.Object newPolisher)`
`void`	`setPropertyPrefix(java.lang.String propertyPrefix)` Prefix used in HTML code for the properties of this view.
`static void`	`setRefiner(java.lang.Object newRefiner)`
`void`	`setRemoveCollectionElementAction(java.lang.String removeCollectionElementAction)`
`void`	`setRemoveSelectedCollectionElementsAction(java.lang.String removeSelectedCollectionElementAction)`
`void`	`setRepresentsAggregate(boolean b)`
`void`	`setRepresentsCollection(boolean b)`
`void`	`setRepresentsEntityReference(boolean b)`
`void`	`setRequest(HttpServletRequest request)`
`void`	`setSaveCollectionElementAction(java.lang.String saveCollectionElementAction)`
`void`	`setSection(boolean b)`
`void`	`setSectionEditable(java.lang.String sectionName, boolean editable)`
`void`	`setSubcontrollersNamesList(java.util.Collection collection)`
`void`	`setSubview(boolean b)`
`void`	`setTitle(java.lang.String title)`
`void`	`setTitleId(java.lang.String id, java.lang.Object... arguments)`
`void`	`setValue(java.lang.String name, java.lang.Object value)` Set the value to the indicated member.
`void`	`setValueNotifying(java.lang.String name, java.lang.Object value)` Set the value and notifies the property change, recalculating all dependent properties.
`void`	`setValues(java.util.Map values)`
`void`	`setValuesExecutingOnChangeActions(java.util.Map values)` Set the values and execute the on-change actions associated to the assigned properties.
`void`	`setValuesNotifying(java.util.Map values)` Set the values and throws are events associated to the changed values.
`void`	`setViewCollectionElementAction(java.lang.String viewCollectionElementAction)`
`void`	`setViewName(java.lang.String newView)`
`void`	`setViewObject(java.lang.String viewObject)` The name of this view as session object.
`boolean`	`throwsPropertyChanged(MetaProperty p)`
`boolean`	`throwsPropertyChanged(java.lang.String propertyName)`
`boolean`	`throwsReferenceChanged(MetaReference ref)`
`java.lang.String`	`toString()`
`boolean`	`trySetValue(java.lang.String name, java.lang.Object value)` Try to set the value to the indicated member.
`void`	`updateModelFromView()` Update the model object set with setModel() from data in the view.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- View
```
public View()
```

Method Detail

setRefiner

public static void setRefiner(java.lang.Object newRefiner)

setPolisher

public static void setPolisher(java.lang.Object newPolisher)

getMetaMembers

public java.util.Collection<MetaMember> getMetaMembers()
                                                throws XavaException

Throws:: XavaException

setMetaMembers

public void setMetaMembers(java.util.Collection metaMembers)

getMetaView

public MetaView getMetaView()
                     throws XavaException

Throws:: XavaException
Since:: 4.8.1

getMetaModel

public MetaModel getMetaModel()
                       throws XavaException

Throws:: XavaException

getValues
```
public java.util.Map getValues()
                        throws XavaException
```
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 java.util.Map getAllValues()
                           throws XavaException
```
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(java.util.Map values)
               throws XavaException

Throws:: XavaException

setValues

public void setValues(java.util.Map values)
               throws XavaException

Throws:: XavaException

getDefaultValueInElementCollection

public java.lang.Object getDefaultValueInElementCollection(java.lang.String qualifiedPropertyName)

Since:: 5.1

setValuesExecutingOnChangeActions
```
public void setValuesExecutingOnChangeActions(java.util.Map values)
                                       throws XavaException
```
Set the values and execute the on-change actions associated to the assigned properties.

Throws:

XavaException

setValuesNotifying
```
public void setValuesNotifying(java.util.Map values)
                        throws XavaException
```
Set the values and throws are events associated to the changed values.

Throws:

XavaException

getValue
```
public java.lang.Object getValue(java.lang.String name)
                          throws XavaException
```
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(java.lang.String memberName)

Since:: 6.2.2

getValueInt

public int getValueInt(java.lang.String name)
                throws XavaException

Parameters:: name - Qualified properties are allowed
Throws:: XavaException

getValueString

public java.lang.String getValueString(java.lang.String name)
                                throws XavaException

Parameters:: name - Qualified properties are allowed
Throws:: XavaException

getSubview

public View getSubview(java.lang.String name)
                throws XavaException

Throws:: XavaException

getGroupView

public View getGroupView(java.lang.String name)
                  throws XavaException

Throws:: XavaException

setValueNotifying

public void setValueNotifying(java.lang.String name,
                              java.lang.Object value)
                       throws ElementNotFoundException,
                              XavaException

Set the value and notifies the property change, recalculating all dependent properties.

Parameters:: name - Can be qualified
Throws:: ElementNotFoundException; XavaException

setValue
```
public void setValue(java.lang.String name,
                     java.lang.Object value)
              throws XavaException
```
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(java.lang.String name,
                           java.lang.Object value)
                    throws XavaException
```
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(java.lang.String sectionName,
                               boolean editable)
                        throws XavaException

Throws:: XavaException

isSectionEditable

public boolean isSectionEditable(java.lang.String sectionName)
                          throws XavaException

Throws:: XavaException

getKeyValuesWithValue

public java.util.Map getKeyValuesWithValue()
                                    throws XavaException

Excludes those values that are null, zero or empty string.

Throws:: XavaException

getKeyValues

public java.util.Map getKeyValues()
                           throws XavaException

Throws:: XavaException

getMembersNamesWithHidden

public java.util.Map getMembersNamesWithHidden()
                                        throws XavaException

Throws:: XavaException

getMembersNames

public java.util.Map getMembersNames()
                              throws XavaException

Throws:: XavaException

getCalculatedPropertiesNames

public java.util.Map getCalculatedPropertiesNames()
                                           throws XavaException

Throws:: XavaException

getCollectionTab
```
public Tab getCollectionTab()
                     throws XavaException
```
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()
                                 throws XavaException
```
Meta data about the collection, only if this view represents a collection.

Throws:

XavaException

Since:

4m6

getCollectionValues
```
public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getCollectionValues()
                                                                                     throws XavaException
```
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()
                      throws XavaException
```
The size of the collection.
In order to call this method this view must represents a collection.

Throws:

XavaException

Since:

4m5

getLabelDecoration

public java.lang.String getLabelDecoration()

Since:: 5.9

getCollectionTotal

public java.lang.Object getCollectionTotal(int row,
                                           int column)

Since:: 4.3

getCollectionTotal

public java.lang.Object getCollectionTotal(java.lang.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 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getTotalProperties()

Since:: 5.9

addCollectionSumProperty

public void addCollectionSumProperty(java.lang.String property)

Since:: 5.9

removeCollectionSumProperty

public void removeCollectionSumProperty(java.lang.String property)

Since:: 5.9

isCollectionTotalCapable

public boolean isCollectionTotalCapable(int column)

isCollectionFixedTotal

public boolean isCollectionFixedTotal(int column)

getCollectionTotalLabel

public java.lang.String getCollectionTotalLabel(int row,
                                                int column)

Since:: 4.3

getCollectionTotalPropertyName

public java.lang.String getCollectionTotalPropertyName(int row,
                                                       int column)

isCollectionTotalEditable

public boolean isCollectionTotalEditable(int row,
                                         int column)

getCollectionSelectedValues
```
public java.util.List getCollectionSelectedValues()
                                           throws XavaException
```
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 java.util.List getCollectionObjects()
                                    throws XavaException
```
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 java.util.List getCollectionSelectedObjects()
                                            throws XavaException
```
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()
                              throws XavaException
```
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
```
public boolean isCollectionCalculated()
                               throws XavaException
```
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 java.util.Collection getMembersNamesWithoutSectionsAndCollections()
                                                                  throws XavaException

Throws:: XavaException

reset
```
public void reset()
           throws XavaException
```
Clear all data and set the default values.

Throws:

XavaException

getBaseModelName
```
public java.lang.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()
           throws XavaException

Clear all displayed data.

Throws:: XavaException

isKeyEditable
```
public boolean isKeyEditable()
```

setKeyEditable

public void setKeyEditable(boolean b)
                    throws XavaException

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(java.lang.String member)
                   throws XavaException

Throws:: XavaException

setEditable
```
public void setEditable(java.lang.String name,
                        boolean editable)
                 throws XavaException
```
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

Throws:: XavaException

getModelName

public java.lang.String getModelName()

setModelName

public void setModelName(java.lang.String newModel)

assignValuesToWebView
```
public void assignValuesToWebView()
```

throwsPropertyChanged

public boolean throwsPropertyChanged(MetaProperty p)

throwsPropertyChanged

public boolean throwsPropertyChanged(java.lang.String propertyName)
                              throws XavaException

Throws:: XavaException

isFirstPropertyAndViewHasNoKeys

public boolean isFirstPropertyAndViewHasNoKeys(MetaProperty pr)
                                        throws XavaException

Throws:: XavaException

hasKeyProperties

public boolean hasKeyProperties()
                         throws XavaException

Throws:: XavaException

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

Throws:

java.lang.Exception

findObject
```
public boolean findObject(MetaProperty changedProperty)
                   throws java.lang.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:

java.lang.Exception

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

getModel
```
public java.lang.Object getModel()
                          throws XavaException
```
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(java.lang.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 java.lang.Object getEntity()
                           throws java.lang.Exception

Entity associated to the current view.

Throws:: java.lang.Exception

getPropertiesNamesFromStereotypesList

public java.util.Collection getPropertiesNamesFromStereotypesList(java.lang.String stereotypesList)
                                                           throws XavaException

Parameters:: stereotypesList - Comma separated
Throws:: XavaException

getMetaProperties

public java.util.List<MetaProperty> getMetaProperties()
                                               throws XavaException

Throws:: XavaException

getMetaProperty

public MetaProperty getMetaProperty(java.lang.String name)
                             throws XavaException

Throws:: XavaException

getMetaReference

public MetaReference getMetaReference(java.lang.String name)
                               throws XavaException

Throws:: XavaException

getMetaPropertiesList

public java.util.List<MetaProperty> getMetaPropertiesList()
                                                   throws XavaException

Throws:: XavaException

getPropertiesNamesFromPropertiesList

public java.util.Collection getPropertiesNamesFromPropertiesList(java.lang.String propertiesList)
                                                          throws XavaException

Parameters:: propertiesList - Properties names comma separated
Throws:: XavaException

getViewName
```
public java.lang.String getViewName()
```

setViewName

public void setViewName(java.lang.String newView)

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

isSubview
```
public boolean isSubview()
```

setSubview
```
public void setSubview(boolean b)
```

isRepresentsAggregate

public boolean isRepresentsAggregate()

setRepresentsAggregate

public void setRepresentsAggregate(boolean b)

getSearchAction

public java.lang.String getSearchAction()
                                 throws XavaException

Throws:: XavaException

isRepresentsCollection

public boolean isRepresentsCollection()

isRepresentsSortableCollection

public boolean isRepresentsSortableCollection()

Since:: 5.6.1

setRepresentsCollection

public void setRepresentsCollection(boolean b)

displayDetailInCollection

public boolean displayDetailInCollection(java.lang.String collectionName)
                                  throws XavaException

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

Throws:: XavaException

getRequest

public HttpServletRequest getRequest()

setRequest

public void setRequest(HttpServletRequest request)
                throws XavaException

Throws:: XavaException

displayAsDescriptionsList

public boolean displayAsDescriptionsList(MetaReference ref)
                                  throws XavaException

Throws:: XavaException

displayAsDescriptionsListAndReferenceView

public boolean displayAsDescriptionsListAndReferenceView(MetaReference ref)
                                                  throws XavaException

Throws:: XavaException

getDescriptionPropertyInDescriptionsList

public java.lang.String getDescriptionPropertyInDescriptionsList(MetaReference ref)
                                                          throws XavaException

Throws:: XavaException

getDescriptionPropertiesInDescriptionsList

public java.lang.String getDescriptionPropertiesInDescriptionsList(MetaReference ref)
                                                            throws XavaException

Throws:: XavaException

throwsReferenceChanged

public boolean throwsReferenceChanged(MetaReference ref)
                               throws XavaException

Throws:: XavaException

getParameterValuesPropertiesInDescriptionsList

public java.lang.String getParameterValuesPropertiesInDescriptionsList(MetaReference ref)
                                                                throws XavaException

Throws:: XavaException

getConditionInDescriptionsList

public java.lang.String getConditionInDescriptionsList(MetaReference ref)
                                                throws XavaException

Throws:: XavaException

getOrderInDescriptionsList

public java.lang.String getOrderInDescriptionsList(MetaReference ref)
                                            throws XavaException

Throws:: XavaException

isOrderByKeyInDescriptionsList

public boolean isOrderByKeyInDescriptionsList(MetaReference ref)
                                       throws XavaException

Throws:: XavaException

isCreateNewForReference

public boolean isCreateNewForReference(MetaReference ref)
                                throws XavaException

Throws:: XavaException

isModifyForReference

public boolean isModifyForReference(MetaReference ref)
                             throws XavaException

Throws:: XavaException

isSearchForReference

public boolean isSearchForReference(MetaReference ref)
                             throws XavaException

Throws:: XavaException

isCreateNew

public boolean isCreateNew()
                    throws XavaException

Throws:: XavaException

isModify

public boolean isModify()
                 throws XavaException

Throws:: XavaException

isSearch

public boolean isSearch()
                 throws XavaException

Throws:: XavaException

isLastSearchKey

public boolean isLastSearchKey(java.lang.String propertyName)
                        throws XavaException

Throws:: XavaException

isLastSearchKey

public boolean isLastSearchKey(MetaProperty p)
                        throws XavaException

Throws:: XavaException

isRepresentsElementCollection

public boolean isRepresentsElementCollection()

getSearchKeyName

public java.lang.String getSearchKeyName()

Since:: 5.7.1

isHidden

public boolean isHidden(java.lang.String name)

setHidden
```
public void setHidden(java.lang.String name,
                      boolean hidden)
               throws XavaException
```
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

Throws:: XavaException

displayAsDescriptionsListAndReferenceView

public boolean displayAsDescriptionsListAndReferenceView()

displayReferenceWithNoFrameEditor

public boolean displayReferenceWithNoFrameEditor(MetaReference ref)

displayWithFrame
```
public boolean displayWithFrame()
```

displayReferenceWithNotCompositeEditor

public boolean displayReferenceWithNotCompositeEditor(MetaReference ref)

getSections

public java.util.List getSections()
                           throws XavaException

Throws:: XavaException

getSectionView

public View getSectionView(int index)
                    throws XavaException

Throws:: XavaException

isSection
```
public boolean isSection()
```

setSection
```
public void setSection(boolean b)
```

getActiveSection

public int getActiveSection()
                     throws XavaException

Throws:: XavaException

setActiveSection
```
public void setActiveSection(int i)
```

getCollectionEditingRow
```
public int getCollectionEditingRow()
```

setCollectionEditingRow

public void setCollectionEditingRow(int i)

getMemberName

public java.lang.String getMemberName()

setMemberName

public void setMemberName(java.lang.String string)
                   throws XavaException

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 java.util.Collection getActionsNamesDetail()
```
Has sense if the subview represents a collection, although always works.

setActionsNamesDetail
```
public void setActionsNamesDetail(java.util.Collection collection)
```
Has sense if the subview represents a collection, although always works.

addDetailAction
```
public void addDetailAction(java.lang.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(java.lang.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(java.lang.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(java.lang.String qualifiedActionName)

removeRowAction

public void removeRowAction(java.lang.String qualifiedActionName)

removeListAction
```
public void removeListAction(java.lang.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 java.util.Collection getRowActionsNames()

getActionsNamesList

public java.util.Collection getActionsNamesList()

getSubcontrollersNamesList

public java.util.Collection<java.lang.String> getSubcontrollersNamesList()

hasListActions
```
public boolean hasListActions()
```

setActionsNamesList

public void setActionsNamesList(java.util.Collection collection)

setSubcontrollersNamesList

public void setSubcontrollersNamesList(java.util.Collection collection)

setActionsNamesRow

public void setActionsNamesRow(java.util.Collection collection)

getActionsNamesRow

public java.util.Collection getActionsNamesRow()

getActionsNamesForProperty

public java.util.Collection getActionsNamesForProperty(MetaProperty p,
                                                       boolean editable)
                                                throws XavaException

Throws:: XavaException

getActionsNamesForReference

public java.util.Collection getActionsNamesForReference(MetaReference ref,
                                                        boolean editable)
                                                 throws XavaException

Throws:: XavaException

getActionsNamesForReference

public java.util.Collection getActionsNamesForReference(boolean editable)
                                                 throws XavaException

If this is a view that represents a reference

Throws:: XavaException

getLabelFormatForProperty

public int getLabelFormatForProperty(MetaProperty p)
                              throws XavaException

Throws:: XavaException

getLabelFormatForReference

public int getLabelFormatForReference(MetaReference ref)
                               throws XavaException

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

Throws:: XavaException

getDisplaySizeForProperty

public int getDisplaySizeForProperty(java.lang.String propertyName)
                              throws XavaException

Throws:: XavaException

isFrame

public boolean isFrame()
                throws XavaException

Throws:: XavaException

getFocusPropertyId

public java.lang.String getFocusPropertyId()

setFocus

public void setFocus(java.lang.String newFocusProperty)

Sets the focus in the provided property

getEditCollectionElementAction

public java.lang.String getEditCollectionElementAction()

getViewCollectionElementAction

public java.lang.String getViewCollectionElementAction()

setEditCollectionElementAction

public void setEditCollectionElementAction(java.lang.String editCollectionElementAction)

setViewCollectionElementAction

public void setViewCollectionElementAction(java.lang.String viewCollectionElementAction)

recalculateProperties
```
public void recalculateProperties()
```

getLabelFor

public java.lang.String getLabelFor(MetaMember p)
                             throws XavaException

Throws:: XavaException

setLabelId

public void setLabelId(java.lang.String propertyName,
                       java.lang.String id)

Parameters:: propertyName - Since v4.2 can qualified; 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 java.lang.String getHideCollectionElementAction()

setHideCollectionElementAction

public void setHideCollectionElementAction(java.lang.String hideCollectionElementAction)

getAddCollectionElementAction

public java.lang.String getAddCollectionElementAction()

getNewCollectionElementAction

public java.lang.String getNewCollectionElementAction()

setNewCollectionElementAction

public void setNewCollectionElementAction(java.lang.String newCollectionElementAction)

getRemoveCollectionElementAction

public java.lang.String getRemoveCollectionElementAction()

setRemoveCollectionElementAction

public void setRemoveCollectionElementAction(java.lang.String removeCollectionElementAction)

getRemoveSelectedCollectionElementsAction

public java.lang.String getRemoveSelectedCollectionElementsAction()

setRemoveSelectedCollectionElementsAction

public void setRemoveSelectedCollectionElementsAction(java.lang.String removeSelectedCollectionElementAction)

getSaveCollectionElementAction

public java.lang.String getSaveCollectionElementAction()

setSaveCollectionElementAction

public void setSaveCollectionElementAction(java.lang.String saveCollectionElementAction)

isAlignedByColumns

public boolean isAlignedByColumns()
                           throws XavaException

Throws:: XavaException
Since:: 5.7

putObject
```
public void putObject(java.lang.String name,
                      java.lang.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 java.lang.Object getObject(java.lang.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(java.lang.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 java.util.Map 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 java.util.Map 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 java.util.Map<java.lang.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








getChangedCollectionSizesInSections
public java.util.Map<View,java.lang.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 java.util.Map 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 java.util.Map<java.lang.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(java.lang.String viewObject)
The name of this view as session object. 







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







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







getPropertyPrefix
public java.lang.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 java.lang.String getQualifiedNameForDisplayedPropertyOrReferenceWithNotCompositeEditor(java.lang.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(java.lang.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 java.lang.String getOnSelectCollectionElementAction()







setOnSelectCollectionElementAction
public void setOnSelectCollectionElementAction(java.lang.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(java.lang.String id,
                       java.lang.Object... arguments)

Since:
4m1








getTitle
public java.lang.String getTitle()

Since:
4m1








setTitle
public void setTitle(java.lang.String title)

Since:
4m1








getLabelStyleForProperty
public java.lang.String getLabelStyleForProperty(MetaProperty p)
                                          throws XavaException

Throws:
XavaException








getLabelStyleForReference
public java.lang.String getLabelStyleForReference(MetaReference ref)
                                           throws XavaException

Throws:
XavaException








setCollapsed
public void setCollapsed(java.lang.String name,
                         boolean collapsed)







isCollapsed
public boolean isCollapsed(java.lang.String name)







setFrameClosed
public void setFrameClosed(java.lang.String frameId,
                           boolean frameClosed)







isFrameClosed
public boolean isFrameClosed(java.lang.String frameId)







addActionForProperty
public void addActionForProperty(java.lang.String property,
                                 java.lang.String qualifiedActionName)
                          throws XavaException
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(java.lang.String property,
                                    java.lang.String qualifiedActionName)
                             throws XavaException
Remove an action to the property. 
 
 Only the actions added with addActionForProperty() can be removed.


Throws:
XavaException
Since:
4.5








propertyHasChangedActions
public boolean propertyHasChangedActions(java.lang.String property)







collectionDeselectAll
public void collectionDeselectAll()
Deselects all items in collection







deselectCollection
public void deselectCollection(java.lang.String deselect)

Parameters:
as - 'ox_OpenXavaTest_CarrierWithCollectionsTogether__xava_collectionTab_fellowCarriers:1,3,2'








moveCollectionElement
public void moveCollectionElement(int from,
                                  int to)
                           throws java.lang.Exception

Throws:
java.lang.Exception








reloadMetaModel
public void reloadMetaModel()

Since:
5.6








setAddCollectionElementAction
public void setAddCollectionElementAction(java.lang.String addCollectionElementAction)







isPropertyUsedInCalculation
public boolean isPropertyUsedInCalculation(java.lang.String qualifiedName)







getDependentCalculationPropertyNameFor
public java.lang.String getDependentCalculationPropertyNameFor(java.lang.String qualifiedName)







addValidValue
public void addValidValue(java.lang.String property,
                          java.lang.Object value,
                          java.lang.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(java.lang.String property,
                             java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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 java.util.Map getValidValues(java.lang.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(java.lang.String referenceName,
                                         java.lang.String condition)
                                  throws XavaException

Throws:
XavaException
Since:
5.8








getDescriptionsListCondition
public java.lang.String getDescriptionsListCondition(java.lang.String referenceName)
                                              throws XavaException

Throws:
XavaException
Since:
5.8

Class View

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

View

Method Detail

setRefiner

setPolisher

getMetaMembers

setMetaMembers

getMetaView

getMetaModel

getValues

getAllValues

addValues

setValues

getDefaultValueInElementCollection

setValuesExecutingOnChangeActions

setValuesNotifying

getValue

isMemberFromElementCollection

getValueInt

getValueString

getSubview

getGroupView

setValueNotifying

setValue

trySetValue

isDataChanged

setSectionEditable

isSectionEditable

getKeyValuesWithValue

getKeyValues

getMembersNamesWithHidden

getMembersNames

getCalculatedPropertiesNames

getCollectionTab

getMetaCollection

getCollectionValues

getCollectionSize

getLabelDecoration

getCollectionTotal

getCollectionTotal

hasCollectionTotal

hasCollectionTotals

hasCollectionSum

getCollectionTotalsCount

getTotalProperties

addCollectionSumProperty

removeCollectionSumProperty

isCollectionTotalCapable

isCollectionFixedTotal

getCollectionTotalLabel

getCollectionTotalPropertyName

isCollectionTotalEditable

getCollectionSelectedValues

getCollectionObjects

getCollectionSelectedObjects

isCollectionFromModel

isCollectionCalculated

getMembersNamesWithoutSectionsAndCollections

reset

getBaseModelName

clear

isKeyEditable

setKeyEditable

isEditable

isEditable

isEditable

setEditable

isEditable

setEditable

getModelName

setModelName

assignValuesToWebView

throwsPropertyChanged

throwsPropertyChanged

isFirstPropertyAndViewHasNoKeys

hasKeyProperties