LayoutItemFIeld: getName(): Use the Field if it is set.

[online-glom:gwt-glom.git] / src / main / java / org / glom / web / shared / libglom / layout / LayoutItemField.java

package org.glom.web.shared.libglom.layout;

import org.glom.web.client.StringUtils;
import org.glom.web.shared.libglom.CustomTitle;
import org.glom.web.shared.libglom.Field;
import org.glom.web.shared.libglom.Field.GlomFieldType;
import org.glom.web.shared.libglom.Relationship;

public class LayoutItemField extends LayoutItemWithFormatting implements UsesRelationship {

        private static final long serialVersionUID = -7101706636312130106L;
        private Field field;

        /*
         * Don't make this final, because that breaks GWT compilation. See
         * http://code.google.com/p/google-web-toolkit/issues/detail?id=1054
         */
        private/* final */UsesRelationship usesRel = new UsesRelationshipImpl();
        private boolean useDefaultFormatting = true;

        /*
         * Don't make this final, because that breaks GWT serialization. See
         * http://code.google.com/p/google-web-toolkit/issues/detail?id=1054
         */
        private/* final */CustomTitle customTitle = new CustomTitle();

        // Extras:
        private String navigationTableName = null; // If any.

        @Override
        public String getName() {
                if(field == null) {
                        return super.getName();
                } else {
                        return field.getName();
                }
        }

        /**
         * @return the field
         */
        public Field getFullFieldDetails() {
                return field;
        }

        /**
         * @param field
         *            the field to set
         */
        public void setFullFieldDetails(final Field field) {
                this.field = field;
        }

        /**
         * @return
         */
        public Formatting getFormattingUsed() {
                if (useDefaultFormatting && (field != null)) {
                        return field.getFormatting();
                } else {
                        return super.getFormatting();
                }
        }

        /**
         * @return
         */
        public GlomFieldType getGlomType() {
                if (field != null) {
                        return field.getGlomType();
                }

                return GlomFieldType.TYPE_INVALID;
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.glom.web.shared.libglom.layout.UsesRelationship#get_table_used(java.lang.String)
         */
        @Override
        public String getTableUsed(final String tableName) {
                return usesRel.getTableUsed(tableName);
        }

        /**
         * @param forDetailsView
         * @return
         */
        public Formatting.HorizontalAlignment getFormattingUsedHorizontalAlignment(final boolean forDetailsView) {
                return null; // TODO
        }

        // TODO: This should actually be in LayoutItem, with an override here.
        /**
         * @return
         */
        public String getLayoutDisplayName() {
                String result = "";

                if (field != null) {
                        result = field.getName();
                } else {
                        result = getName();
                }

                // Indicate if it's a field in another table.
                if (getHasRelatedRelationshipName()) {
                        final Relationship rel = getRelatedRelationship();
                        if (rel != null) {
                                result = rel.getName() + "::" + result;
                        }
                }

                if (getHasRelationshipName()) {
                        final Relationship rel = getRelationship();
                        if (rel != null) {
                                result = rel.getName() + "::" + result;
                        }
                }

                return result;
        }

        /*
         * (non-Javadoc)
         * 
         * @see
         * org.glom.web.shared.libglom.layout.UsesRelationship#setRelationship(org.glom.web.shared.libglom.Relationship)
         */
        @Override
        public void setRelationship(final Relationship relationship) {
                usesRel.setRelationship(relationship);
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.glom.web.shared.libglom.layout.UsesRelationship#getRelationship()
         */
        @Override
        public Relationship getRelationship() {
                return usesRel.getRelationship();
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.glom.web.shared.libglom.layout.UsesRelationship#getHasRelationshipName()
         */
        @Override
        public boolean getHasRelationshipName() {
                return usesRel.getHasRelationshipName();
        }

        /*
         * (non-Javadoc)
         * 
         * @see
         * org.glom.web.shared.libglom.layout.UsesRelationship#setRelatedRelationship(org.glom.web.shared.libglom.Relationship
         * )
         */
        @Override
        public void setRelatedRelationship(final Relationship relationship) {
                usesRel.setRelatedRelationship(relationship);
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.glom.web.shared.libglom.layout.UsesRelationship#getRelatedRelationship()
         */
        @Override
        public Relationship getRelatedRelationship() {
                return usesRel.getRelatedRelationship();
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.glom.web.shared.libglom.layout.UsesRelationship#getHasRelatedRelationshipName()
         */
        @Override
        public boolean getHasRelatedRelationshipName() {
                return usesRel.getHasRelatedRelationshipName();
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.glom.web.shared.libglom.layout.UsesRelationship#getSqlJoinAliasName()
         */
        @Override
        public String getSqlJoinAliasName() {
                return usesRel.getSqlJoinAliasName();
        }

        /**
         * @param attribute
         */
        public void setUseDefaultFormatting(final boolean useDefaultFormatting) {
                this.useDefaultFormatting = useDefaultFormatting;
        }

        /**
         * @return
         */
        public boolean getUseDefaultFormatting() {
                return useDefaultFormatting;
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.glom.web.shared.libglom.layout.UsesRelationship#getSqlTableOrJoinAliasName(java.lang.String)
         */
        @Override
        public String getSqlTableOrJoinAliasName(final String tableName) {
                return usesRel.getSqlTableOrJoinAliasName(tableName);
        }

        /**
         * @return
         */
        public String getNavigationTableName() {
                return navigationTableName;
        }

        // TODO: Use this.
        public void setNavigationTableName(final String navigationtableName) {
                this.navigationTableName = navigationtableName;
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.glom.web.shared.libglom.layout.UsesRelationship#getRelationshipNameUsed()
         */
        @Override
        public String getRelationshipNameUsed() {
                return usesRel.getRelationshipNameUsed();
        }

        @Override
        public String getTitleOriginal() {
                if (customTitle.getUseCustomTitle()) {
                        return customTitle.getTitleOriginal();
                }

                if (field != null) {
                        return field.getTitleOriginal();
                }

                return "";
        }

        @Override
        public String getTitle(final String locale) {
                if (customTitle.getUseCustomTitle()) {
                        return customTitle.getTitle(locale);
                }

                // Fallback to the field's title:
                String title = "";
                if (field != null) {
                        title = field.getTitle(locale);
                }

                // Fallback to the field's original title:
                if (StringUtils.isEmpty(title) && (field != null)) {
                        title = field.getTitleOriginal();
                }

                return title;
        }

        @Override
        public String getTitleOrName(final String locale) {
                if (customTitle.getUseCustomTitle()) {
                        return customTitle.getTitle(locale);
                        // TODO: Do not force the use of empty translations.
                }

                // Fallback to the field's original title:
                if (field != null) {
                        return field.getTitleOrName(locale);
                }

                return getName();
        }

        public CustomTitle getCustomTitle() {
                return customTitle;
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.glom.web.shared.libglom.layout.UsesRelationship#getTitleUsed(java.lang.String, java.lang.String)
         */
        @Override
        public String getTitleUsed(final String parentTableTitle, final String locale) {
                return usesRel.getTitleUsed(parentTableTitle, locale);
        }

}