com.wewebu.ow.server.plug.owrecord
Class OwRecordPreviewPropertyView

java.lang.Object
  com.wewebu.ow.server.ui.OwEventTarget
      com.wewebu.ow.server.ui.OwView
          com.wewebu.ow.server.ui.OwLayout
              com.wewebu.ow.server.plug.owrecord.OwRecordPreviewPropertyView

All Implemented Interfaces:

com.wewebu.ow.server.field.OwFieldProvider, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwUpdateTarget

public class OwRecordPreviewPropertyView
extends com.wewebu.ow.server.ui.OwLayout
implements com.wewebu.ow.server.field.OwFieldProvider

View to display a set of properties of the opened folder.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Nested Class Summary

Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout

com.wewebu.ow.server.ui.OwLayout.OwDispatchRegion

Field Summary

protected boolean	m_isDynamicSplitUsed flag specify if dynamic split is used
protected com.wewebu.ow.server.app.OwMaxMinButtonControlView	m_minMaxView min max view module to display the minimize - maximize button
protected List	m_PreviewProperties a list of preview properties to display right away next to the record
protected com.wewebu.ow.server.app.OwFieldManager	m_theFieldManager instance of the property field class
static int	MIN_MAX_REGION region of the min max view
static String	PREVIEW_PROPERTIES_DIV_ID DIV id for property preview
static String	SETTINGS_PARAM_PREVIEW_PROPERTIES parameter name for the preview parameters to be displayed.

Fields inherited from class com.wewebu.ow.server.ui.OwLayout

m_Regions

Fields inherited from class com.wewebu.ow.server.ui.OwView

CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget

Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider

TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL

Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView

EMPTY_STRING

Constructor Summary

OwRecordPreviewPropertyView()

Method Summary

com.wewebu.ow.server.field.OwField	getField(String strFieldClassName_p)
String	getFieldProviderName()
Object	getFieldProviderSource()
int	getFieldProviderType()
Collection	getFields() get all the properties in the form
com.wewebu.ow.server.ecm.OwProperty	getProperty(String strPropertyName_p) get the specified property from the current record
List	getPropertyNames() get the defined properties to display
Object	getSafeFieldValue(String sName_p, Object defaultvalue_p) retrieve the value of a Field
String	getTitle() overridable title of the view
protected void	init() init the target after the context is set.
boolean	isDynamicSplitUsed() Getter for flag dynamic split
boolean	isNamedRegion(String strRegion_p) determine if region exists
void	onAjaxUpdate(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p) Handler for AJAX request to update the content.
void	onRender(Writer w_p) render the view
void	renderNamedRegion(Writer w_p, String strRegion_p) render only a region in the view, used by derived classes
void	renderProperty(com.wewebu.ow.server.ecm.OwProperty prop_p, Writer w_p) render the property
void	setDynamicSplitUsed(boolean isDynamicSplitUsed_p) Setter for dynamic split flag.
void	setField(String sName_p, Object value_p) modify a Field value, but does not save the value right away

Methods inherited from class com.wewebu.ow.server.ui.OwLayout

addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderRegion

Methods inherited from class com.wewebu.ow.server.ui.OwView

activate, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes

Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget

attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget

Methods inherited from class java.lang.Object

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

Field Detail

m_PreviewProperties

protected List m_PreviewProperties

a list of preview properties to display right away next to the record

m_theFieldManager

protected com.wewebu.ow.server.app.OwFieldManager m_theFieldManager

instance of the property field class

SETTINGS_PARAM_PREVIEW_PROPERTIES

public static final String SETTINGS_PARAM_PREVIEW_PROPERTIES

parameter name for the preview parameters to be displayed.

See Also:

Constant Field Values

MIN_MAX_REGION

public static final int MIN_MAX_REGION

region of the min max view

See Also:

Constant Field Values

PREVIEW_PROPERTIES_DIV_ID

public static final String PREVIEW_PROPERTIES_DIV_ID

DIV id for property preview

See Also:

Constant Field Values

m_minMaxView

protected com.wewebu.ow.server.app.OwMaxMinButtonControlView m_minMaxView

min max view module to display the minimize - maximize button

m_isDynamicSplitUsed

protected boolean m_isDynamicSplitUsed

flag specify if dynamic split is used

Constructor Detail

OwRecordPreviewPropertyView

public OwRecordPreviewPropertyView()

Method Detail

init

protected void init()
             throws Exception

init the target after the context is set.

Overrides:

init in class com.wewebu.ow.server.ui.OwView

Throws:

Exception

getTitle

public String getTitle()

overridable title of the view

Specified by:

getTitle in interface com.wewebu.ow.server.ui.OwBaseView

Overrides:

getTitle in class com.wewebu.ow.server.ui.OwView

Returns:

String localized display name for the view

renderNamedRegion

public void renderNamedRegion(Writer w_p,
                              String strRegion_p)
                       throws Exception

render only a region in the view, used by derived classes

Specified by:

renderNamedRegion in interface com.wewebu.ow.server.ui.OwBaseView

Overrides:

renderNamedRegion in class com.wewebu.ow.server.ui.OwLayout

Parameters:

w_p - Writer object to write HTML to

strRegion_p - named region to render

Throws:

Exception

renderProperty

public void renderProperty(com.wewebu.ow.server.ecm.OwProperty prop_p,
                           Writer w_p)
                    throws Exception

render the property

Parameters:

prop_p - OwProperty

w_p - Writer

Throws:

Exception

isNamedRegion

public boolean isNamedRegion(String strRegion_p)
                      throws Exception

determine if region exists

Specified by:

isNamedRegion in interface com.wewebu.ow.server.ui.OwBaseView

Overrides:

isNamedRegion in class com.wewebu.ow.server.ui.OwView

Parameters:

strRegion_p - name of the region to render

Returns:

true if region contains anything and should be rendered

Throws:

Exception

getProperty

public com.wewebu.ow.server.ecm.OwProperty getProperty(String strPropertyName_p)
                                                throws Exception

get the specified property from the current record

Parameters:

strPropertyName_p - String property name

Returns:

OwProperty or null if not available in record

Throws:

Exception

getPropertyNames

public List getPropertyNames()

get the defined properties to display

Returns:

List of String, or null if nothing is defined

onRender

public void onRender(Writer w_p)
              throws Exception

render the view

Overrides:

onRender in class com.wewebu.ow.server.ui.OwView

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

getField

public com.wewebu.ow.server.field.OwField getField(String strFieldClassName_p)
                                            throws Exception,
                                                   com.wewebu.ow.server.exceptions.OwObjectNotFoundException

Specified by:

getField in interface com.wewebu.ow.server.field.OwFieldProvider

Throws:

Exception

com.wewebu.ow.server.exceptions.OwObjectNotFoundException

getFieldProviderType

public int getFieldProviderType()

Specified by:

getFieldProviderType in interface com.wewebu.ow.server.field.OwFieldProvider

getFieldProviderSource

public Object getFieldProviderSource()

Specified by:

getFieldProviderSource in interface com.wewebu.ow.server.field.OwFieldProvider

getFieldProviderName

public String getFieldProviderName()

Specified by:

getFieldProviderName in interface com.wewebu.ow.server.field.OwFieldProvider

setField

public void setField(String sName_p,
                     Object value_p)
              throws Exception,
                     com.wewebu.ow.server.exceptions.OwObjectNotFoundException

modify a Field value, but does not save the value right away

Specified by:

setField in interface com.wewebu.ow.server.field.OwFieldProvider

Parameters:

sName_p -

value_p -

Throws:

Exception

com.wewebu.ow.server.exceptions.OwObjectNotFoundException

getSafeFieldValue

public Object getSafeFieldValue(String sName_p,
                                Object defaultvalue_p)

retrieve the value of a Field

Specified by:

getSafeFieldValue in interface com.wewebu.ow.server.field.OwFieldProvider

Parameters:

sName_p -

defaultvalue_p -

Returns:

Object the value of the Field of defaultvalue_p

getFields

public Collection getFields()
                     throws Exception

get all the properties in the form

Specified by:

getFields in interface com.wewebu.ow.server.field.OwFieldProvider

Returns:

Collection of OwField

Throws:

Exception

setDynamicSplitUsed

public void setDynamicSplitUsed(boolean isDynamicSplitUsed_p)

Setter for dynamic split flag.

Parameters:

isDynamicSplitUsed_p -

Since:

3.1.0.0

isDynamicSplitUsed

public boolean isDynamicSplitUsed()

Getter for flag dynamic split

Returns:

true if the dynamic splitter is used.

Since:

3.1.0.0

onAjaxUpdate

public void onAjaxUpdate(javax.servlet.http.HttpServletRequest request_p,
                         javax.servlet.http.HttpServletResponse response_p)
                  throws Exception

Handler for AJAX request to update the content.

Parameters:

request_p - - the AJAX request object.

response_p - - the response

Throws:

Exception

Since:

3.1.0.0