Package org.openxava.view.meta

Class MetaView

java.lang.Object

org.openxava.util.meta.MetaElement

org.openxava.view.meta.MetaView

All Implemented Interfaces:

Serializable, Cloneable

public class MetaView
extends MetaElement
implements Cloneable

Author:

Javier Paniza

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetaView()

Method Summary

Modifier and Type	Method	Description
void	addMetaGroup(String name, String label, String members, boolean alignedByColumns)
void	addMetaViewCollection(MetaCollectionView metaCollectionView)
void	addMetaViewProperty(MetaProperty metaProperty)
void	addMetaViewProperty(MetaPropertyView metaPropertyView)
void	addMetaViewReference(MetaReferenceView metaReferenceView)
MetaView	addSection(String name, String label, String members, boolean alignedByColumns)
void	clearSections()
protected Object	clone()
boolean	containsViewProperty(String name)
MetaDescriptionsList	createMetaDescriptionList(MetaReference r)
IOnChangePropertyAction	createOnChangeAction(String qualifiedPropertyName)
IOnChangePropertyAction	createOnChangeSearchAction(String refName)
Collection	getActionsNamesForProperty(MetaProperty p, boolean editable)
Collection	getActionsNamesForReference(MetaReference ref, boolean editable)
int	getDisplaySizeForProperty(MetaProperty p)
String	getEditorFor(MetaMember m)
String	getExtendsView()
String	getId()	Unique id of element, normally used to search the label in the resources files.
protected String	getLabel(Locale locale, String id)	Implementation of label obtaining.
int	getLabelFormatFor(MetaMember m)	If not label format specified for the member returns the defaultLabelFormat from XavaPreferences.
Integer	getLabelFormatForProperty(MetaProperty p)	If not label format specified for the property returns null.
Integer	getLabelFormatForReference(MetaReference ref)	If not label format specified for the reference returns null.
String	getLabelStyleForProperty(MetaProperty p)
String	getLabelStyleForReference(MetaReference ref)
String	getMediatorClassName()
Collection	getMembersNames()
MetaCollectionView	getMetaCollectionView(String collectionName)
MetaDescriptionsList	getMetaDescriptionList(MetaReference r)
Collection	getMetaDescriptionsLists()
Collection	getMetaMembers()
MetaModel	getMetaModel()
MetaProperty	getMetaProperty(String name)	Including if property is inside a section
MetaPropertyView	getMetaPropertyViewFor(String qualifiedPropertyName)
MetaReferenceView	getMetaReferenceView(MetaReference r)
MetaReferenceView	getMetaReferenceViewFor(String ref)
MetaSearchAction	getMetaSearchAction()	To search the objects of type that is represents by this view.
MetaView	getMetaView(MetaReference r)
MetaView	getMetaView(MetaReference r, MetaModel metaModelReferenced)
MetaView	getMetaViewOnlyKeys(MetaReference r)
Collection	getMetaViewProperties()
String	getModelName()
Collection	getNotAlwaysEnabledViewActionsNames()
Collection	getPropertiesNamesThrowOnChange()
List<MetaView>	getSections()
Collection	getViewPropertiesNames()
boolean	hasMetaSearchAction()
boolean	hasOnChangeAction(String qualifiedPropertyName)
boolean	hasSections()
boolean	isAlignedByColumns()
boolean	isAllMembers()
boolean	isEmpty()	If does not have members to visualize.
boolean	isFrame()
void	setAlignedByColumns(boolean alignedByColumns)
void	setAllMembers(boolean newAllMembers)
void	setExtendsView(String extendsView)
void	setFrame(boolean frame)
void	setMediatorClassName(String mediatorClassName)
void	setMembersNames(String membersNames)
void	setMembersNamesNotResetSections(String membersNames)
void	setMetaModel(MetaModel metaModel)
void	setMetaSearchAction(MetaSearchAction metaSearchAction)
void	setModelName(String modelName)
void	setName(String newName)	If newName is null or empty is replaced by emptySection.

Methods inherited from class org.openxava.util.meta.MetaElement

getDescription, getDescription, getDescription, getDescription, getLabel, getLabel, getLabel, getLocale, getName, getPlaceholder, getPlaceholder, getPlaceholder, has18nLabel, hasName, setDescription, setLabel, setPlaceholder

Methods inherited from class java.lang.Object

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

Constructor Details

MetaView

public MetaView()

Method Details

addMetaViewProperty

public void addMetaViewProperty(MetaProperty metaProperty)
                         throws XavaException

Throws:

XavaException

addMetaViewReference

public void addMetaViewReference(MetaReferenceView metaReferenceView)
                          throws XavaException

Throws:

XavaException

addMetaViewProperty

public void addMetaViewProperty(MetaPropertyView metaPropertyView)
                         throws XavaException

Throws:

XavaException

addMetaViewCollection

public void addMetaViewCollection(MetaCollectionView metaCollectionView)
                           throws XavaException

Throws:

XavaException

getMetaProperty

public MetaProperty getMetaProperty(String name)
                             throws XavaException

Including if property is inside a section

Throws:

XavaException

getMetaMembers

public Collection getMetaMembers()
                          throws XavaException

Returns:

Not null, of type MetaMember and read only

Throws:

XavaException

getMetaModel

public MetaModel getMetaModel()
                       throws XavaException

Returns:

Not null

Throws:

XavaException

setMetaModel

public void setMetaModel(MetaModel metaModel)
                  throws XavaException

Throws:

XavaException

getModelName

public String getModelName()
                    throws XavaException

Throws:

XavaException

setModelName

public void setModelName(String modelName)
                  throws XavaException

Throws:

XavaException

setName

public void setName(String newName)

If newName is null or empty is replaced by emptySection.

If newName contains blanks (\n, \r, \t, \f) or whitespace are suppressed.

Overrides:

setName in class MetaElement

Since:

5.2.1

isAllMembers

public boolean isAllMembers()

isEmpty

public boolean isEmpty()
                throws XavaException

If does not have members to visualize.

Throws:

XavaException

getMembersNames

public Collection getMembersNames()
                           throws XavaException

Returns:

Not nul, of type String and read only.

Throws:

XavaException

setMembersNames

public void setMembersNames(String membersNames)
                     throws XavaException

Parameters:

membersNames - Names separated by commas or spaces.

Throws:

XavaException

setMembersNamesNotResetSections

public void setMembersNamesNotResetSections(String membersNames)
                                     throws XavaException

Parameters:

membersNames - Names separated by commas or spaces.

Throws:

XavaException

setAllMembers

public void setAllMembers(boolean newAllMembers)

hasOnChangeAction

public boolean hasOnChangeAction(String qualifiedPropertyName)

createOnChangeAction

public IOnChangePropertyAction createOnChangeAction(String qualifiedPropertyName)
                                             throws XavaException

Throws:

XavaException

createOnChangeSearchAction

public IOnChangePropertyAction createOnChangeSearchAction(String refName)
                                                   throws XavaException

Throws:

XavaException

hasMetaSearchAction

public boolean hasMetaSearchAction()

getMetaSearchAction

public MetaSearchAction getMetaSearchAction()

To search the objects of type that is represents by this view. Not for the references

setMetaSearchAction

public void setMetaSearchAction(MetaSearchAction metaSearchAction)

getMetaDescriptionList

public MetaDescriptionsList getMetaDescriptionList(MetaReference r)
                                            throws XavaException

Returns:

Null if not found

Throws:

XavaException

createMetaDescriptionList

public MetaDescriptionsList createMetaDescriptionList(MetaReference r)
                                               throws XavaException

Throws:

XavaException

getMetaDescriptionsLists

public Collection getMetaDescriptionsLists()

Returns:

of type MetaDescriptionsList

getMetaViewOnlyKeys

public MetaView getMetaViewOnlyKeys(MetaReference r)
                             throws XavaException

Throws:

XavaException

getMetaView

public MetaView getMetaView(MetaReference r)
                     throws XavaException

Throws:

XavaException

getMetaView

public MetaView getMetaView(MetaReference r,
 MetaModel metaModelReferenced)
                     throws XavaException

Throws:

XavaException

Since:

5.3.1

getMetaReferenceView

public MetaReferenceView getMetaReferenceView(MetaReference r)

Returns:

Null if not found

getMetaPropertyViewFor

public MetaPropertyView getMetaPropertyViewFor(String qualifiedPropertyName)

getMetaReferenceViewFor

public MetaReferenceView getMetaReferenceViewFor(String ref)

getSections

public List<MetaView> getSections()
                           throws XavaException

Throws:

XavaException

addSection

public MetaView addSection(String name,
 String label,
 String members,
 boolean alignedByColumns)
                    throws XavaException

Returns:

The added section

Throws:

XavaException

addMetaGroup

public void addMetaGroup(String name,
 String label,
 String members,
 boolean alignedByColumns)
                  throws XavaException

Throws:

XavaException

hasSections

public boolean hasSections()

clearSections

public void clearSections()

getMediatorClassName

public String getMediatorClassName()
                            throws XavaException

Throws:

XavaException

setMediatorClassName

public void setMediatorClassName(String mediatorClassName)

getMetaCollectionView

public MetaCollectionView getMetaCollectionView(String collectionName)

Returns:

Null if not found

isFrame

public boolean isFrame()

setFrame

public void setFrame(boolean frame)

getId

public String getId()

Description copied from class: MetaElement

Unique id of element, normally used to search the label in the resources files.

Specified by:

getId in class MetaElement

getLabel

protected String getLabel(Locale locale,
 String id)

Description copied from class: MetaElement

Implementation of label obtaining.

Overrides:

getLabel in class MetaElement

getPropertiesNamesThrowOnChange

public Collection getPropertiesNamesThrowOnChange()

getViewPropertiesNames

public Collection getViewPropertiesNames()

getMetaViewProperties

public Collection getMetaViewProperties()

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getActionsNamesForProperty

public Collection getActionsNamesForProperty(MetaProperty p,
 boolean editable)

getActionsNamesForReference

public Collection getActionsNamesForReference(MetaReference ref,
 boolean editable)

getLabelFormatForProperty

public Integer getLabelFormatForProperty(MetaProperty p)

If not label format specified for the property returns null.

getLabelFormatForReference

public Integer getLabelFormatForReference(MetaReference ref)

If not label format specified for the reference returns null.

getLabelFormatFor

public int getLabelFormatFor(MetaMember m)

If not label format specified for the member returns the defaultLabelFormat from XavaPreferences.

Since:

5.7

getDisplaySizeForProperty

public int getDisplaySizeForProperty(MetaProperty p)
                              throws XavaException

Throws:

XavaException

getEditorFor

public String getEditorFor(MetaMember m)

Returns:

Empty string if no editor is defined for this property

isAlignedByColumns

public boolean isAlignedByColumns()

setAlignedByColumns

public void setAlignedByColumns(boolean alignedByColumns)

containsViewProperty

public boolean containsViewProperty(String name)

getNotAlwaysEnabledViewActionsNames

public Collection getNotAlwaysEnabledViewActionsNames()

getExtendsView

public String getExtendsView()

setExtendsView

public void setExtendsView(String extendsView)

getLabelStyleForProperty

public String getLabelStyleForProperty(MetaProperty p)

getLabelStyleForReference

public String getLabelStyleForReference(MetaReference ref)