Package snap.view

Class DocView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.DocView

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

public class DocView
extends ParentView

A view to represent a traditional paper document.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PageMargin_Prop

Fields inherited from class snap.view.ParentView

_children, Child_Prop, NeedsLayout_Prop

Fields inherited from class snap.view.View

_align, _borderRadius, _effect, _font, _margin, _padding, _repaintRect, _showing, _spacing, _vertical, Action, Align_Prop, Border_Prop, BorderRadius_Prop, Clip_Prop, Cursor_Prop, DEFAULT_ALIGN, DEFAULT_MARGIN, DEFAULT_PADDING, DEFAULT_SPACING, Disabled_Prop, DragEvents, Effect_Prop, Fill_Prop, Focusable_Prop, Focused_Prop, FocusWhenPressed_Prop, Font_Prop, GrowHeight_Prop, GrowWidth_Prop, Height_Prop, KeyEvents, KeyPress, KeyRelease, KeyType, LeanX_Prop, LeanY_Prop, Margin_Prop, MaxHeight_Prop, MaxWidth_Prop, MinHeight_Prop, MinWidth_Prop, MouseDrag, MouseEnter, MouseEvents, MouseExit, MouseMove, MousePress, MouseRelease, Name_Prop, Opacity_Prop, Padding_Prop, Paintable_Prop, Parent_Prop, Pickable_Prop, PrefHeight_Prop, PrefWidth_Prop, Rotate_Prop, ScaleX_Prop, ScaleY_Prop, Scroll, Showing_Prop, Spacing_Prop, Text_Prop, ToolTip_Prop, TransX_Prop, TransY_Prop, Vertical_Prop, Visible_Prop, Width_Prop, X_Prop, Y_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
DocView()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addPage(PageView aPage)	Adds a given page.
void	addPage(PageView aPage, int anIndex)	Adds a given page at given index.
protected void	fromXMLChildren(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival for shape children.
PageView	getPage()	Returns the page node.
PageView	getPage(int anIndex)	Returns the individual page at given index.
int	getPageCount()	Returns the number of pages.
Insets	getPageMargin()	Returns the page margin.
protected double	getPrefHeightImpl(double aW)	Returns the preferred height.
protected double	getPrefWidthImpl(double aH)	Returns the preferred width.
int	getSelIndex()	Returns the selected page index.
PageView	getSelPage()	Returns the currently selected page.
protected void	layoutImpl()	Layout children.
PageView	removePage(int anIndex)	Removes the page at given index.
int	removePage(PageView aPage)	Removes the given page.
void	setPage(PageView aPage)	Sets the page node.
void	setPageMargin(Insets aIns)	Sets the page margin.
void	setSelIndex(int anIndex)	Sets the selected page index.
void	setSelPage(PageView aPage)	Sets the currently selected page.
void	toXMLChildren(XMLArchiver anArchiver, XMLElement anElement)	XML archival deep.

Methods inherited from class snap.view.ParentView

addChild, addChild, addDeepChangeListener, childDidDeepChange, childDidPropChange, fromXML, fromXMLView, getChild, getChildAt, getChildAt, getChildCount, getChildCountManaged, getChildForClass, getChildForName, getChildLast, getChildren, getChildrenForClass, getChildrenManaged, getFocusNext, getFocusPrev, getPropValue, getViewList, getViewProxy, indexOfChild, initProps, intersects, isInLayout, isNeedsLayout, isNeedsLayoutDeep, isNeedsRepaintDeep, layout, layoutDeep, layoutDeepImpl, layoutFloatingViews, paintAbove, paintAll, paintChildren, parentFontChanged, processPropChange, relayout, removeChild, removeChild, removeChildren, removeDeepChangeListener, setChildren, setFont, setNeedsLayout, setNeedsLayoutDeep, setNeedsRepaintDeep, setOwner, setOwnerChildren, setPropValue, setShowing, themeChanged, toXML, toXMLView

Methods inherited from class snap.view.View

addBinding, addEventFilter, addEventHandler, clone, contains, contains, contains, disableEvents, dispatchEventToView, enableEvents, fireActionEvent, getAlign, getAlignX, getAlignY, getAnim, getAnimCleared, getAnimTimeDeep, getBestHeight, getBestSize, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBorder, getBorderRadius, getBounds, getBoundsLocal, getBoundsParent, getBoundsShape, getBoundsShapeParent, getClip, getClipAll, getClipAllBounds, getClipBounds, getClippedRect, getCursor, getDefaultBorder, getDefaultFill, getDefaultFont, getEffect, getEnv, getEventAdapter, getFill, getFillColor, getFocusNext, getFocusPrev, getFont, getHeight, getHost, getInsetsAll, getLean, getLeanX, getLeanY, getLocalToParent, getLocalToParent, getMargin, getMaxHeight, getMaxSize, getMaxWidth, getMaxX, getMaxY, getMidX, getMidY, getMinHeight, getMinHeightImpl, getMinSize, getMinWidth, getMinWidthImpl, getName, getOpacity, getOpacityAll, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefSize, getPrefWidth, getPrefWidth, getProp, getPropDefault, getProps, getRealClassName, getRepaintRect, getRepaintRectExpanded, getRootView, getRotate, getScale, getScaleX, getScaleY, getSize, getSpacing, getText, getToolTip, getToolTip, getTransX, getTransY, getUpdater, getValuePropName, getVisRect, getWidth, getWindow, getX, getXY, getY, indexInHost, indexInParent, isActionable, isAncestor, isClipToBounds, isDisabled, isEnabled, isFocusable, isFocused, isFocusKeysEnabled, isFocusPainted, isFocusWhenPressed, isFontSet, isGrowHeight, isGrowWidth, isGuest, isHorizontal, isLocalToParentSimple, isManaged, isManagedVisible, isMaxHeightSet, isMaxWidthSet, isMinHeightSet, isMinWidthSet, isMouseDown, isMouseOver, isNeedsRepaint, isPaintable, isPickable, isPickableVisible, isPrefHeightSet, isPrefWidthSet, isShowing, isToolTipEnabled, isVertical, isVisible, localToParent, localToParent, localToParent, localToParent, localToScreen, paintBack, paintFront, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEvent, processEventFilters, processEventHandlers, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, setAnimTimeDeep, setBorder, setBorder, setBorderRadius, setBounds, setBounds, setBoundsLocal, setClip, setClipToBounds, setCursor, setDisabled, setEffect, setEnabled, setFill, setFocusable, setFocused, setFocusKeysEnabled, setFocusPainted, setFocusWhenPressed, setGrowHeight, setGrowWidth, setHeight, setLean, setLeanX, setLeanY, setManaged, setMargin, setMargin, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth, setName, setOpacity, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setRealClassName, setRotate, setScale, setScaleX, setScaleY, setSize, setSize, setSizeLocal, setSizeToPrefSize, setSpacing, setText, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setVisible, setWidth, setX, setXY, setXYLocal, setY, stopAnimDeep, toStringProps

Methods inherited from class snap.props.PropObject

addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, isPropDefault, removePropChangeListener, removePropChangeListener, toString

Methods inherited from class java.lang.Object

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

Field Details

PageMargin_Prop

public static final String PageMargin_Prop

See Also:

• Constant Field Values

Constructor Details

DocView

public DocView()

Constructor.

Method Details

getPageCount

public int getPageCount()

Returns the number of pages.

getPage

public PageView getPage(int anIndex)

Returns the individual page at given index.

addPage

public void addPage(PageView aPage)

Adds a given page.

addPage

public void addPage(PageView aPage,
 int anIndex)

Adds a given page at given index.

removePage

public PageView removePage(int anIndex)

Removes the page at given index.

removePage

public int removePage(PageView aPage)

Removes the given page.

getPageMargin

public Insets getPageMargin()

Returns the page margin.

setPageMargin

public void setPageMargin(Insets aIns)

Sets the page margin.

getSelIndex

public int getSelIndex()

Returns the selected page index.

setSelIndex

public void setSelIndex(int anIndex)

Sets the selected page index.

getSelPage

public PageView getSelPage()

Returns the currently selected page.

setSelPage

public void setSelPage(PageView aPage)

Sets the currently selected page.

getPage

public PageView getPage()

Returns the page node.

setPage

public void setPage(PageView aPage)

Sets the page node.

getPrefWidthImpl

protected double getPrefWidthImpl(double aH)

Returns the preferred width.

Overrides:

getPrefWidthImpl in class View

getPrefHeightImpl

protected double getPrefHeightImpl(double aW)

Returns the preferred height.

Overrides:

getPrefHeightImpl in class View

layoutImpl

protected void layoutImpl()

Layout children.

Overrides:

layoutImpl in class ParentView

toXMLChildren

public void toXMLChildren(XMLArchiver anArchiver,
 XMLElement anElement)

XML archival deep.

Overrides:

toXMLChildren in class ParentView

fromXMLChildren

protected void fromXMLChildren(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival for shape children.

Overrides:

fromXMLChildren in class ParentView