root/dydoc/FieldDoc.java

//
//      ===========================================================================
//
//      Title:          FieldDoc.java
//      Description:    Somehwat similar to javadoc
//      Author:         Rapha‘l Szwarc <zoe (underscore) info (at) mac (dot) com>
//      Creation Date:  Thu Dec 09 2004
//      Legal:          Copyright (C) 2004 Rapha‘l Szwarc
//
//      This software is provided 'as-is', without any express or implied warranty. 
//      In no event will the author be held liable for any damages arising from 
//      the use of this software.
//
//      Permission is granted to anyone to use this software for any purpose, 
//      including commercial applications, and to alter it and 
//      redistribute it freely, subject to the following restrictions:
//
//      1. The origin of this software must not be misrepresented; 
//      you must not claim that you wrote the original software. 
//      If you use this software in a product, an acknowledgment
//      in the product documentation would be appreciated but is not required.
//
//      2. Altered source versions must be plainly marked as such, 
//      and must not be misrepresented as being the original software.
//
//      3. This notice may not be removed or altered from any source distribution.
//
//      ---------------------------------------------------------------------------
//

package alt.dev.dydoc;

import java.io.File;

import java.lang.reflect.Field;
import java.lang.reflect.Modifier;

import java.util.Collection;
import java.util.Map;
import java.util.HashMap;

import alt.dev.szapp.SZComponent;
import alt.dev.szapp.SZContext;
import alt.dev.szapp.SZTemplate;
import alt.dev.szapp.SZSpanString;
import alt.dev.szapp.SZHTMLCoder;
import alt.dev.szapp.SZURIEncoder;

import alt.dev.szfoundation.SZLog;

public class FieldDoc extends Component
{

//      ===========================================================================
//      Constant(s)
//      ---------------------------------------------------------------------------

//      ===========================================================================
//      Class variable(s)
//      ---------------------------------------------------------------------------

//      ===========================================================================
//      Instance variable(s)
//      ---------------------------------------------------------------------------

        private Field           _value = null;
        private Collection      _values = null;
        private Map             _valueProperties = null;

//      ===========================================================================
//      Constructor method(s)
//      ---------------------------------------------------------------------------

        protected FieldDoc(final SZContext aContext, final SZComponent aParent, final Map someBindings)
        {
                super( aContext, aParent, someBindings );
        }

//      ===========================================================================
//      Class method(s)
//      ---------------------------------------------------------------------------

//      ===========================================================================
//      Instance method(s)
//      ---------------------------------------------------------------------------

        protected Field value()
        {
                if ( _value == null )
                {
                        _value = (Field) this.valueForBinding( "value" );
                }
                
                return _value;
        }

        protected Collection values()
        {
                if ( _values == null )
                {
                        _values = (Collection) this.valueForBinding( "values" );
                }
                
                return _values;
        }

        protected Map valueProperties()
        {
                if ( _valueProperties == null )
                {
                        Map     aMap = (Map) this.valueForBinding( "valueProperties" );
                        
                        _valueProperties = new HashMap();

                        if ( aMap != null )
                        {
                                Map     anotherMap = null;
                                
                                anotherMap = (Map) aMap.get( "class.variables" );
                                
                                if ( anotherMap != null )
                                {
                                        _valueProperties.putAll( anotherMap );
                                }
                                
                                anotherMap = (Map) aMap.get( "instance.variables" );
                                
                                if ( anotherMap != null )
                                {
                                        _valueProperties.putAll( anotherMap );
                                }
                        }
                }
                
                return _valueProperties;
        }

//      ===========================================================================
//      Display method(s)
//      ---------------------------------------------------------------------------

        protected String variableAnchor()
        {
                StringBuffer    aBuffer = new StringBuffer();
                String          aName = this.value().getName();
                
                aName = aName.replace( ':', '.' );
                aName = SZURIEncoder.encode( aName );
                
                aBuffer.append( "<a name = \"" );
                aBuffer.append( aName );
                aBuffer.append( "\"></a>" );
                
                return aBuffer.toString();
        }

        protected SZComponent variableTitle()
        {
                Map             someBindings = new HashMap();
                                someBindings.put( "value", this.value().getName() );
                                someBindings.put( "isBig", Boolean.TRUE );
                                someBindings.put( "isBold", Boolean.TRUE );
                                someBindings.put( "class", "Title" );
                SZComponent     aComponent = new SZSpanString( this.context(), this, someBindings );
                
                return aComponent;
        }

        protected String modifiers()
        {
                return Modifier.toString( this.value().getModifiers() );
        }

        protected SZComponent type()
        {
                Class           aType = this.value().getType();
                SZComponent     aComponent = ClassDoc.altLinkForClassInComponent( aType, this );
                
                if ( ClassInfo.contains( this.values(), aType ) == false )
                {
                        aComponent.takeValueForBinding( Boolean.FALSE, "isEnabled" );
                }
                
                return aComponent;
        }

        protected String description()
        {
                String  aValue = (String) this.valueProperties().get( this.value().getName() );
                
                if ( ( aValue == null ) || ( aValue.length() == 0 ) )
                {
                        aValue = this.property( "No description available for this variable." );
                }
                
                return aValue;
        }

        public String toString()
        {
                SZTemplate      aTemplate = this.template();
                
                aTemplate.set( "variableAnchor", this.variableAnchor() );
                aTemplate.set( "variableTitle", this.variableTitle() );
                aTemplate.set( "modifiers", this.modifiers() );
                aTemplate.set( "type", this.type() );
                aTemplate.set( "description", this.description() );
                
                return aTemplate.toString();
        }

}