Package com.levigo.jadice.web.shared.model.settings

Class PageViewSettings

java.lang.Object

com.levigo.jadice.web.shared.model.settings.AbstractListenableRenderSettings

com.levigo.jadice.web.shared.model.settings.PageViewSettings

All Implemented Interfaces:

RenderSettings

public class PageViewSettings
extends AbstractListenableRenderSettings

An implementation RenderSettings pertaining and particular to the rendering within com.levigo.jadice.web.client.PageView objectss.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOCUMENT_OFFSET_BOTTOM	A property key for the document offset bottom.
static final String	DOCUMENT_OFFSET_TOP	A property key for the document offset top.
static final String	DYNAMIC_ZOOM_MODE	A property key for the dynamic zoom mode.
static final int	START_OF_USER_ZOOM_MODES	User-specific zoom modes bay be allocated starting from this constant.
static final int	ZOOM_MODE_FIT_BOTH	Dynamically fit pages vertical and horizontal.
static final int	ZOOM_MODE_FIT_HEIGHT	Dynamically fit pages vertical.
static final int	ZOOM_MODE_FIT_WIDTH	Dynamically fit pages horizontal.
static final int	ZOOM_MODE_NONE	No dynamic zoom.

Constructor Summary

Constructors

Constructor	Description
PageViewSettings()

Method Summary

Modifier and Type	Method	Description
PageViewSettings	createSnapshot()
boolean	equals(Object obj)
void	fitBoth()	Dynamically zoom pages so that they fit completely into the page view.
void	fitHeight()	Dynamically zoom pages so that they fill the page view vertically.
void	fitWidth()	Dynamically zoom pages so that they fill the page view horizontally.
Integer	getDocumentOffsetBottom()
Integer	getDocumentOffsetTop()
int	getDynamicZoomMode()
int	hashCode()
protected void	setDefaults()	Initializes additional settings.
void	setDocumentOffsetBottom(Integer documentOffsetBottom)	Set the bottom offset of the document.
void	setDocumentOffsetTop(Integer documentOffsetTop)	Set the top offset of the document.
void	setDynamicZoomMode(int dynamicZoomMode)
String	toString()
void	update(String propertyName, RenderSettings other, Object... details)	Updates this instance property specified by given property name with the value provided by the other processing setting.

Methods inherited from class com.levigo.jadice.web.shared.model.settings.AbstractListenableRenderSettings

addListener, fireChanged, getParent, init, removeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DYNAMIC_ZOOM_MODE

public static final String DYNAMIC_ZOOM_MODE

A property key for the dynamic zoom mode.

See Also:

• setDynamicZoomMode(int)
• getDynamicZoomMode()
• Constant Field Values

DOCUMENT_OFFSET_TOP

public static final String DOCUMENT_OFFSET_TOP

A property key for the document offset top.

See Also:

• Constant Field Values

DOCUMENT_OFFSET_BOTTOM

public static final String DOCUMENT_OFFSET_BOTTOM

A property key for the document offset bottom.

See Also:

• Constant Field Values

ZOOM_MODE_NONE

public static final int ZOOM_MODE_NONE

No dynamic zoom.

See Also:

• setDynamicZoomMode(int)
• Constant Field Values

ZOOM_MODE_FIT_WIDTH

public static final int ZOOM_MODE_FIT_WIDTH

Dynamically fit pages horizontal.

See Also:

• setDynamicZoomMode(int)
• Constant Field Values

ZOOM_MODE_FIT_HEIGHT

public static final int ZOOM_MODE_FIT_HEIGHT

Dynamically fit pages vertical.

See Also:

• setDynamicZoomMode(int)
• Constant Field Values

ZOOM_MODE_FIT_BOTH

public static final int ZOOM_MODE_FIT_BOTH

Dynamically fit pages vertical and horizontal.

See Also:

• setDynamicZoomMode(int)
• Constant Field Values

START_OF_USER_ZOOM_MODES

public static final int START_OF_USER_ZOOM_MODES

User-specific zoom modes bay be allocated starting from this constant.

See Also:

• Constant Field Values

Constructor Details

PageViewSettings

public PageViewSettings()

Method Details

setDefaults

protected void setDefaults()

Description copied from class: AbstractListenableRenderSettings

Initializes additional settings.

Specified by:

setDefaults in class AbstractListenableRenderSettings

update

public void update(String propertyName,
 RenderSettings other,
 Object... details)

Description copied from interface: RenderSettings

Updates this instance property specified by given property name with the value provided by the other processing setting. For each update-supported property the render settings type have to provide a unique property name.

Parameters:

propertyName - the name of the property to update. Update supported properties have unique property identifier provided by the specific render settings implementation.

other - the processing setting which provide the new property value. Therefore, the other processing setting have to be of the same type as this instance.

details - (optional) if some describing details are necessary to do a specific update, the details parameter will transport this information

createSnapshot

public PageViewSettings createSnapshot()

getDynamicZoomMode

public int getDynamicZoomMode()

setDynamicZoomMode

public void setDynamicZoomMode(int dynamicZoomMode)

fitWidth

public void fitWidth()

Dynamically zoom pages so that they fill the page view horizontally.

See Also:

• ZOOM_MODE_FIT_WIDTH

fitHeight

public void fitHeight()

Dynamically zoom pages so that they fill the page view vertically.

See Also:

• ZOOM_MODE_FIT_HEIGHT

fitBoth

public void fitBoth()

Dynamically zoom pages so that they fit completely into the page view.

See Also:

• ZOOM_MODE_FIT_BOTH

getDocumentOffsetTop

public Integer getDocumentOffsetTop()

Returns:

the top offset of the document. By default 0.

setDocumentOffsetTop

public void setDocumentOffsetTop(Integer documentOffsetTop)

Set the top offset of the document. By default this offset is 0.

Parameters:

documentOffsetTop - the top offset of the document

getDocumentOffsetBottom

public Integer getDocumentOffsetBottom()

Returns:

the bottom offset of the document. By default 0.

setDocumentOffsetBottom

public void setDocumentOffsetBottom(Integer documentOffsetBottom)

Set the bottom offset of the document. By default this offset is 0.

Parameters:

documentOffsetBottom - the bottom offset of the document

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object