com.swfm.mica.editors
Class MiPageManager

java.lang.Object
  com.swfm.mica.model.MiModelEntity
      com.swfm.mica.editors.MiPageManager

All Implemented Interfaces:

MiiActionHandler, MiiActionTypes, MiiDistanceUnits, MiiModelEntity, MiiModelTypes, MiiNames, MiiPropertyTypes, MiiTypes

public class MiPageManager

extends MiModelEntity

implements MiiDistanceUnits, MiiTypes, MiiPropertyTypes, MiiNames

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

static java.lang.String	Mi_LANDSCAPE_NAME
static java.lang.String	Mi_PAGE_BACKGROUND_COLOR_NAME
static java.lang.String	Mi_PAGE_BACKGROUND_COLOR_NAME_NSP
static java.lang.String	Mi_PAGE_BORDER_BACKGROUND_COLOR_NAME
static java.lang.String	Mi_PAGE_BORDER_BACKGROUND_COLOR_NAME_NSP
static java.lang.String	Mi_PAGE_BORDER_COLOR_NAME
static java.lang.String	Mi_PAGE_BORDER_COLOR_NAME_NSP
static java.lang.String	Mi_PAGE_BORDER_NAME
static java.lang.String	Mi_PAGE_BORDER_NAME_NSP
static java.lang.String	Mi_PAGE_BORDER_TITLE_BLOCK_BACKGROUND_COLOR_NAME
static java.lang.String	Mi_PAGE_BORDER_TITLE_BLOCK_BACKGROUND_COLOR_NAME_NSP
static int	Mi_PAGE_MANAGER_CHANGED_ACTION
static java.lang.String	Mi_PAGE_MANAGER_CHANGED_ACTION_NAME
static int	Mi_PAGE_MANAGER_CHANGED_REFERENCE_GRID_POINT_ACTION
static java.lang.String	Mi_PAGE_MANAGER_CHANGED_REFERENCE_GRID_POINT_ACTION_NAME
static java.lang.String	Mi_PAGE_ORIENTATION_NAME
static int	Mi_PAGE_SIZE_CHANGED_ACTION
static java.lang.String	Mi_PAGE_SIZE_CHANGED_ACTION_NAME
static java.lang.String	Mi_PAGE_SIZE_NAME
static java.lang.String	Mi_PAGE_SIZE_NAME_NSP
static int	Mi_PAGE_UNITS_CHANGED_ACTION
static java.lang.String	Mi_PAGE_UNITS_CHANGED_ACTION_NAME
static java.lang.String	Mi_PAGES_TALL_NAME
static java.lang.String	Mi_PAGES_TALL_NAME_NSP
static java.lang.String	Mi_PAGES_WIDE_NAME
static java.lang.String	Mi_PAGES_WIDE_NAME_NSP
static java.lang.String	Mi_PORTRAIT_NAME
static java.lang.String	Mi_SNAP_TO_GRID_ENABLED_NAME

Constructor Summary

MiPageManager()

Method Summary

void	_setEditor(MiEditor editor)
void	assignCopyTo(MiEditor otherEditor)
MiPart	getBackgroundLayer()
MiDrawingGrid	getDrawingGrid()
MiDrawingPages	getDrawingPages()
MiEditor	getEditor()
boolean	getHasDrawingPages()
boolean	getHasLayers()
boolean	getIncludeAccessToDrawingGridProperties()
MiLayerManager	getLayerManager()
int	getOrientation()
MiAttributes	getPageAttributes()
MiiPageBorderGraphicsGenerator	getPageBorderGraphicsGenerator()
boolean	getPageOriginAtUpperLeft()
MiPaperSize	getPageSize() If this is 'customPageSize' then it's size is invalid i.e.
MiSize	getPageSizeInUnits()
MiSize	getPageSizeInWorld()
int	getPagesTall()
int	getPagesWide()
MiPropertyDescriptions	getPropertyDescriptions() Gets the descriptions of all of the properties.
Strings	getPropertyNames()
java.lang.String	getPropertyValue(java.lang.String name) Gets the textual value of the property with the given name.
MiSnapManager	getSnapManager()
MiDistanceUnits	getUnits()
MiSimpleTransform	getUnitsToWorldTransform()
MiSimpleTransform	getWorldToUnitsTransform()
void	registerPageBorderGraphicsGenerators(java.util.Vector generators)
void	setDrawingGrid(MiDrawingGrid drawingGrid)
void	setDrawingPages(MiDrawingPages drawingPages)
void	setHasDrawingGrid(boolean flag)
void	setHasDrawingPages(boolean flag)
void	setHasLayers(boolean flag)
void	setIncludeAccessToDrawingGridProperties(boolean flag)
void	setOrientation(int orientation)
void	setPageAttributes(MiAttributes atts)
void	setPageBorderGraphicsGenerator(MiiPageBorderGraphicsGenerator generator)
void	setPageBorderGraphicsGenerator(java.lang.String generatorName)
void	setPageOriginAtUpperLeft(boolean flag)
void	setPageSize(MiPaperSize pageSize)
void	setPageSize(MiSize size)
void	setPageSizeInUnits(MiSize sizeInUnits)
void	setPagesTall(int numPages)
void	setPagesWide(int numPages)
void	setPropertyValue(java.lang.String name, java.lang.String value) Sets the property with the given name to the given value.
void	setSnapManager(MiSnapManager snapManager)
void	setUnits(MiDistanceUnits units)
MiPoint	transformUnitsPointToWorldPoint(MiPoint pt)
MiPoint	transformWorldPointToUnitsPoint(MiPoint pt)

Methods inherited from class com.swfm.mica.model.MiModelEntity

appendModelChangeHandler, appendModelEntity, appendModelRelation, appendPropertyChangeHandler, copy, copy, createModelEntity, createModelRelation, deepCopy, deepCopy, deleteSelf, dispatchModelChangeEvent, dispatchPropertyChange, dispatchPropertyChangeEvent, dump, dump, equals, equalsProperties, getChild, getChildren, getDefaultPropertyValue, getEditingPermissions, getIgnoreCase, getIndexOfModelEntity, getLocation, getModelChangeHandler, getModelEntities, getModelEntity, getModelEntity, getModelRelations, getName, getNumberOfModelChangeHandlers, getNumberOfModelEntities, getNumberOfPropertyChangeHandlers, getParent, getPropertiesAreOrdered, getPropertyChangeHandler, getTitle, getType, getUserData, hasUserData, insertModelEntity, insertModelRelation, isObservedProperty, isToCopyEntitysRelationsWhenDeepCopyEntity, processAction, removeAllModelEntities, removeAllModelRelations, removeAllProperties, removeModelChangeHandler, removeModelEntity, removeModelRelation, removeProperty, removePropertyChangeHandler, removeSelf, replaceSelf, setIgnoreCase, setLocation, setModelChangeEventDispatchingEnabled, setName, setParent, setPropertiesAreOrdered, setPropertiesToDefaultValues, setPropertyChangeEventDispatchingEnabled, setPropertyDescriptions, setTitle, setToCopyEntitysRelationsWhenDeepCopyEntity, setType, toString, toString, validateModelEntity, validateModelRelation, validatePropertyValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Mi_SNAP_TO_GRID_ENABLED_NAME

public static final java.lang.String Mi_SNAP_TO_GRID_ENABLED_NAME

See Also:

Constant Field Values

Mi_PAGE_SIZE_CHANGED_ACTION_NAME

public static final java.lang.String Mi_PAGE_SIZE_CHANGED_ACTION_NAME

See Also:

Constant Field Values

Mi_PAGE_SIZE_CHANGED_ACTION

public static final int Mi_PAGE_SIZE_CHANGED_ACTION

Mi_PAGE_MANAGER_CHANGED_ACTION_NAME

public static final java.lang.String Mi_PAGE_MANAGER_CHANGED_ACTION_NAME

See Also:

Constant Field Values

Mi_PAGE_MANAGER_CHANGED_ACTION

public static final int Mi_PAGE_MANAGER_CHANGED_ACTION

Mi_PAGE_UNITS_CHANGED_ACTION_NAME

public static final java.lang.String Mi_PAGE_UNITS_CHANGED_ACTION_NAME

See Also:

Constant Field Values

Mi_PAGE_UNITS_CHANGED_ACTION

public static final int Mi_PAGE_UNITS_CHANGED_ACTION

Mi_PAGE_MANAGER_CHANGED_REFERENCE_GRID_POINT_ACTION_NAME

public static final java.lang.String Mi_PAGE_MANAGER_CHANGED_REFERENCE_GRID_POINT_ACTION_NAME

See Also:

Constant Field Values

Mi_PAGE_MANAGER_CHANGED_REFERENCE_GRID_POINT_ACTION

public static final int Mi_PAGE_MANAGER_CHANGED_REFERENCE_GRID_POINT_ACTION

Mi_PAGE_SIZE_NAME

public static final java.lang.String Mi_PAGE_SIZE_NAME

See Also:

Constant Field Values

Mi_PAGES_WIDE_NAME

public static final java.lang.String Mi_PAGES_WIDE_NAME

See Also:

Constant Field Values

Mi_PAGES_TALL_NAME

public static final java.lang.String Mi_PAGES_TALL_NAME

See Also:

Constant Field Values

Mi_PAGE_BORDER_NAME

public static final java.lang.String Mi_PAGE_BORDER_NAME

See Also:

Constant Field Values

Mi_PAGE_ORIENTATION_NAME

public static final java.lang.String Mi_PAGE_ORIENTATION_NAME

See Also:

Constant Field Values

Mi_PAGE_BORDER_COLOR_NAME

public static final java.lang.String Mi_PAGE_BORDER_COLOR_NAME

See Also:

Constant Field Values

Mi_PAGE_BORDER_BACKGROUND_COLOR_NAME

public static final java.lang.String Mi_PAGE_BORDER_BACKGROUND_COLOR_NAME

See Also:

Constant Field Values

Mi_PAGE_BORDER_TITLE_BLOCK_BACKGROUND_COLOR_NAME

public static final java.lang.String Mi_PAGE_BORDER_TITLE_BLOCK_BACKGROUND_COLOR_NAME

See Also:

Constant Field Values

Mi_PAGE_BACKGROUND_COLOR_NAME

public static final java.lang.String Mi_PAGE_BACKGROUND_COLOR_NAME

See Also:

Constant Field Values

Mi_LANDSCAPE_NAME

public static final java.lang.String Mi_LANDSCAPE_NAME

See Also:

Constant Field Values

Mi_PORTRAIT_NAME

public static final java.lang.String Mi_PORTRAIT_NAME

See Also:

Constant Field Values

Mi_PAGE_SIZE_NAME_NSP

public static final java.lang.String Mi_PAGE_SIZE_NAME_NSP

See Also:

Constant Field Values

Mi_PAGES_WIDE_NAME_NSP

public static final java.lang.String Mi_PAGES_WIDE_NAME_NSP

See Also:

Constant Field Values

Mi_PAGES_TALL_NAME_NSP

public static final java.lang.String Mi_PAGES_TALL_NAME_NSP

See Also:

Constant Field Values

Mi_PAGE_BORDER_NAME_NSP

public static final java.lang.String Mi_PAGE_BORDER_NAME_NSP

See Also:

Constant Field Values

Mi_PAGE_BORDER_BACKGROUND_COLOR_NAME_NSP

public static final java.lang.String Mi_PAGE_BORDER_BACKGROUND_COLOR_NAME_NSP

See Also:

Constant Field Values

Mi_PAGE_BORDER_TITLE_BLOCK_BACKGROUND_COLOR_NAME_NSP

public static final java.lang.String Mi_PAGE_BORDER_TITLE_BLOCK_BACKGROUND_COLOR_NAME_NSP

See Also:

Constant Field Values

Mi_PAGE_BACKGROUND_COLOR_NAME_NSP

public static final java.lang.String Mi_PAGE_BACKGROUND_COLOR_NAME_NSP

See Also:

Constant Field Values

Mi_PAGE_BORDER_COLOR_NAME_NSP

public static final java.lang.String Mi_PAGE_BORDER_COLOR_NAME_NSP

See Also:

Constant Field Values

Constructor Detail

MiPageManager

public MiPageManager()

Method Detail

_setEditor

public void _setEditor(MiEditor editor)

getEditor

public MiEditor getEditor()

assignCopyTo

public void assignCopyTo(MiEditor otherEditor)

setDrawingGrid

public void setDrawingGrid(MiDrawingGrid drawingGrid)

getDrawingGrid

public MiDrawingGrid getDrawingGrid()

setHasLayers

public void setHasLayers(boolean flag)

getHasLayers

public boolean getHasLayers()

getLayerManager

public MiLayerManager getLayerManager()

getBackgroundLayer

public MiPart getBackgroundLayer()

setDrawingPages

public void setDrawingPages(MiDrawingPages drawingPages)

getDrawingPages

public MiDrawingPages getDrawingPages()

registerPageBorderGraphicsGenerators

public void registerPageBorderGraphicsGenerators(java.util.Vector generators)

setPageBorderGraphicsGenerator

public void setPageBorderGraphicsGenerator(java.lang.String generatorName)

setPageBorderGraphicsGenerator

public void setPageBorderGraphicsGenerator(MiiPageBorderGraphicsGenerator generator)

getPageBorderGraphicsGenerator

public MiiPageBorderGraphicsGenerator getPageBorderGraphicsGenerator()

setHasDrawingPages

public void setHasDrawingPages(boolean flag)

getHasDrawingPages

public boolean getHasDrawingPages()

setHasDrawingGrid

public void setHasDrawingGrid(boolean flag)

getSnapManager

public MiSnapManager getSnapManager()

setSnapManager

public void setSnapManager(MiSnapManager snapManager)

setIncludeAccessToDrawingGridProperties

public void setIncludeAccessToDrawingGridProperties(boolean flag)

getIncludeAccessToDrawingGridProperties

public boolean getIncludeAccessToDrawingGridProperties()

setOrientation

public void setOrientation(int orientation)

getOrientation

public int getOrientation()

setPageSize

public void setPageSize(MiPaperSize pageSize)

getPageSize

public MiPaperSize getPageSize()

If this is 'customPageSize' then it's size is invalid i.e. getPageSize().getSize() is not useful. Use getPageSizeInUnits() or getPageSizeInWorld() instead.

getPageSizeInWorld

public MiSize getPageSizeInWorld()

setUnits

public void setUnits(MiDistanceUnits units)

getUnits

public MiDistanceUnits getUnits()

setPageSizeInUnits

public void setPageSizeInUnits(MiSize sizeInUnits)

getPageSizeInUnits

public MiSize getPageSizeInUnits()

setPageSize

public void setPageSize(MiSize size)

setPageAttributes

public void setPageAttributes(MiAttributes atts)

getPageAttributes

public MiAttributes getPageAttributes()

setPagesWide

public void setPagesWide(int numPages)

getPagesWide

public int getPagesWide()

setPagesTall

public void setPagesTall(int numPages)

getPagesTall

public int getPagesTall()

setPageOriginAtUpperLeft

public void setPageOriginAtUpperLeft(boolean flag)

getPageOriginAtUpperLeft

public boolean getPageOriginAtUpperLeft()

getWorldToUnitsTransform

public MiSimpleTransform getWorldToUnitsTransform()

transformWorldPointToUnitsPoint

public MiPoint transformWorldPointToUnitsPoint(MiPoint pt)

getUnitsToWorldTransform

public MiSimpleTransform getUnitsToWorldTransform()

transformUnitsPointToWorldPoint

public MiPoint transformUnitsPointToWorldPoint(MiPoint pt)

getPropertyNames

public Strings getPropertyNames()

Specified by:

getPropertyNames in interface MiiModelEntity

Overrides:

getPropertyNames in class MiModelEntity

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             java.lang.String value)

Sets the property with the given name to the given value.

Specified by:

setPropertyValue in interface MiiModelEntity

Overrides:

setPropertyValue in class MiModelEntity

Parameters:

name - the name of an property

value - the value of the property

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name)

Gets the textual value of the property with the given name. If the value is null then MiiTypes.Mi_NULL_VALUE_NAME is returned.

Specified by:

getPropertyValue in interface MiiModelEntity

Overrides:

getPropertyValue in class MiModelEntity

Parameters:

name - the name of a property

Returns:

the string value of the property

getPropertyDescriptions

public MiPropertyDescriptions getPropertyDescriptions()

Gets the descriptions of all of the properties. These can be used to see if an property is different from the default value or if a proposed value is valid or to get a list of all of the valid values of a property.

Specified by:

getPropertyDescriptions in interface MiiModelEntity

Overrides:

getPropertyDescriptions in class MiModelEntity

Returns:

the list of property descriptions