com.guiseframework.model.ui
Class AbstractPresentationModel

java.lang.Object
  extended by com.globalmentor.beans.BoundPropertyObject
      extended by com.guiseframework.event.GuiseBoundPropertyObject
          extended by com.guiseframework.model.ui.AbstractPresentationModel
All Implemented Interfaces:
com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, Displayable, Model, PresentationModel
Direct Known Subclasses:
AbstractComponent, Table.ColumnUIModel

public abstract class AbstractPresentationModel
extends GuiseBoundPropertyObject
implements PresentationModel

An abstract implementation of presentation-related information.

Author:
Garret Wilson

Field Summary
 
Fields inherited from class com.globalmentor.beans.BoundPropertyObject
NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS
 
Fields inherited from interface com.guiseframework.model.ui.PresentationModel
BACKGROUND_COLOR_PROPERTY, BORDER_LINE_FAR_COLOR_PROPERTY, BORDER_LINE_FAR_EXTENT_PROPERTY, BORDER_LINE_FAR_STYLE_PROPERTY, BORDER_LINE_NEAR_COLOR_PROPERTY, BORDER_LINE_NEAR_EXTENT_PROPERTY, BORDER_LINE_NEAR_STYLE_PROPERTY, BORDER_PAGE_FAR_COLOR_PROPERTY, BORDER_PAGE_FAR_EXTENT_PROPERTY, BORDER_PAGE_FAR_STYLE_PROPERTY, BORDER_PAGE_NEAR_COLOR_PROPERTY, BORDER_PAGE_NEAR_EXTENT_PROPERTY, BORDER_PAGE_NEAR_STYLE_PROPERTY, CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CURSOR_PROPERTY, FONT_FAMILIES_PROPERTY, FONT_SIZE_PROPERTY, FONT_STYLE_PROPERTY, FONT_WEIGHT_BOLD, FONT_WEIGHT_NORMAL, FONT_WEIGHT_PROPERTY, LABEL_FONT_FAMILIES_PROPERTY, LABEL_FONT_SIZE_PROPERTY, LABEL_FONT_STYLE_PROPERTY, LABEL_FONT_WEIGHT_PROPERTY, LABEL_TEXT_COLOR_PROPERTY, LINE_EXTENT_PROPERTY, MARGIN_LINE_FAR_EXTENT_PROPERTY, MARGIN_LINE_NEAR_EXTENT_PROPERTY, MARGIN_PAGE_FAR_EXTENT_PROPERTY, MARGIN_PAGE_NEAR_EXTENT_PROPERTY, OPACITY_PROPERTY, PADDING_LINE_FAR_EXTENT_PROPERTY, PADDING_LINE_NEAR_EXTENT_PROPERTY, PADDING_PAGE_FAR_EXTENT_PROPERTY, PADDING_PAGE_NEAR_EXTENT_PROPERTY, PAGE_EXTENT_PROPERTY, ROUNDED_CORNER_ARC_SIZE, STYLE_ID_PROPERTY, TEXT_COLOR_PROPERTY, TOOLTIP_ENABLED_PROPERTY, VISIBLE_PROPERTY
 
Fields inherited from interface com.guiseframework.model.Model
PLAIN_TEXT_CONTENT_TYPE, XHTML_CONTENT_TYPE, XHTML_FRAGMENT_CONTENT_TYPE
 
Fields inherited from interface com.guiseframework.model.Displayable
DISPLAYED_PROPERTY
 
Constructor Summary
AbstractPresentationModel()
          Default constructor.
 
Method Summary
 Color BorderLineFarColor()
          Returns the border color of the line far page near border.
 Extent BorderLineFarExtent()
          Returns the border extent of the line far page near border.
 LineStyle BorderLineFarStyle()
          Returns the border style of the line far page near border.
 Color BorderLineNearColor()
          Returns the border color of the line near page near border.
 Extent BorderLineNearExtent()
          Returns the border extent of the line near page near border.
 LineStyle BorderLineNearStyle()
          Returns the border style of the line near page near border.
 Color BorderPageFarColor()
          Returns the border color of the line far page far border.
 Extent BorderPageFarExtent()
          Returns the border extent of the line far page far border.
 LineStyle BorderPageFarStyle()
          Returns the border style of the line far page far border.
 Color BorderPageNearColor()
          Returns the border color of the line near page far border.
 Extent BorderPageNearExtent()
          Returns the border extent of the line near page far border.
 LineStyle BorderPageNearStyle()
          Returns the border style of the line near page far border.
 Color getBackgroundColor()
           
 Color getBorderColor(Border border)
          Returns the border color of the indicated border.
 Extent getBorderExtent(Border border)
          Returns the border extent of the indicated border.
 LineStyle getBorderStyle(Border border)
          Returns the border style of the indicated border.
 Dimensions getCornerArcSize(Corner corner)
          Returns the arc size for the indicated corner.
 Dimensions getCornerLineFarPageFarArcSize()
          Returns the arc size for the line far page far corner.
 Dimensions getCornerLineFarPageNearArcSize()
          Returns the arc size for the line far page near corner.
 Dimensions getCornerLineNearPageFarArcSize()
          Returns the arc size for the line near page far corner.
 Dimensions getCornerLineNearPageNearArcSize()
          Returns the arc size for the line near page near corner.
 java.net.URI getCursor()
           
 Extent getExtent(Flow flow)
          Returns the extent of the indicated flow.
 java.util.List<java.lang.String> getFontFamilies()
           
 Extent getFontSize()
           
 FontStyle getFontStyle()
           
 double getFontWeight()
           
 java.util.List<java.lang.String> getLabelFontFamilies()
           
 Extent getLabelFontSize()
           
 FontStyle getLabelFontStyle()
           
 double getLabelFontWeight()
           
 Color getLabelTextColor()
           
 Extent getLineExtent()
          Returns the extent of the line flow.
 Extent getMarginExtent(Border border)
          Returns the margin extent of the indicated border.
 Extent getMarginLineFarExtent()
          Returns the margin extent of the line far page near border.
 Extent getMarginLineNearExtent()
          Returns the margin extent of the line near page near border.
 Extent getMarginPageFarExtent()
          Returns the margin extent of the line far page far border.
 Extent getMarginPageNearExtent()
          Returns the margin extent of the line near page far border.
 double getOpacity()
           
 Extent getPaddingExtent(Border border)
          Returns the padding extent of the indicated border.
 Extent getPaddingLineFarExtent()
          Returns the padding extent of the line far page near border.
 Extent getPaddingLineNearExtent()
          Returns the padding extent of the line near page near border.
 Extent getPaddingPageFarExtent()
          Returns the padding extent of the line far page far border.
 Extent getPaddingPageNearExtent()
          Returns the padding extent of the line near page far border.
 Extent getPageExtent()
          Returns the extent of the page flow.
 java.lang.String getStyleID()
           
 Color getTextColor()
           
 boolean isDisplayed()
           
 boolean isTooltipEnabled()
           
 boolean isVisible()
           
 void setBackgroundColor(Color newBackgroundColor)
          Sets the background color of the component.
 void setBorderColor(Border border, Color newBorderColor)
          Sets the border color of a given border.
 void setBorderColor(Color newBorderColor)
          Sets the border color of all borders.
 void setBorderExtent(Border border, Extent newBorderExtent)
          Sets the border extent of a given border.
 void setBorderExtent(Extent newBorderExtent)
          Sets the border extent of all borders.
 void setBorderLineFarColor(Color newBorderColor)
          Sets the border color of the line far border.
 void setBorderLineFarExtent(Extent newBorderExtent)
          Sets the border extent of the line far border.
 void setBorderLineFarStyle(LineStyle newBorderStyle)
          Sets the border style of the line far border.
 void setBorderLineNearColor(Color newBorderColor)
          Sets the border COLOR of the line near border.
 void setBorderLineNearExtent(Extent newBorderExtent)
          Sets the border extent of the line near border.
 void setBorderLineNearStyle(LineStyle newBorderStyle)
          Sets the border style of the line near border.
 void setBorderPageFarColor(Color newBorderColor)
          Sets the border color of the page far border.
 void setBorderPageFarExtent(Extent newBorderExtent)
          Sets the border extent of the page far border.
 void setBorderPageFarStyle(LineStyle newBorderStyle)
          Sets the border style of the page far border.
 void setBorderPageNearColor(Color newBorderColor)
          Sets the border color of the page near border.
 void setBorderPageNearExtent(Extent newBorderExtent)
          Sets the border extent of the page near border.
 void setBorderPageNearStyle(LineStyle newBorderStyle)
          Sets the border style of the page near border.
 void setBorderStyle(Border border, LineStyle newBorderStyle)
          Sets the border style of a given border.
 void setBorderStyle(LineStyle newBorderStyle)
          Sets the border style of all borders.
 void setCornerArcSize(Corner corner, Dimensions newCornerArcSize)
          Sets the arc size of a given corner.
 void setCornerArcSize(Dimensions newCornerArcSize)
          Sets the arc size of all corners.
 void setCornerLineFarPageFarArcSize(Dimensions newCornerArcSize)
          Sets the arc size of the line far page far corner.
 void setCornerLineFarPageNearArcSize(Dimensions newCornerArcSize)
          Sets the arc size of the line far page near corner.
 void setCornerLineNearPageFarArcSize(Dimensions newCornerArcSize)
          Sets the arc size of the line near page far corner.
 void setCornerLineNearPageNearArcSize(Dimensions newCornerArcSize)
          Sets the arc size of the line near page near corner.
 void setCursor(java.net.URI newCursor)
          Sets the URI of the cursor.
 void setDisplayed(boolean newDisplayed)
          Sets whether the component is displayed or has no representation, taking up no space.
 void setExtent(Flow flow, Extent newExtent)
          Sets the extent of a given flow.
 void setFontFamilies(java.util.List<java.lang.String> newFontFamilies)
          Sets the font families of the component.
 void setFontSize(Extent newFontSize)
          Sets the font size of the component.
 void setFontStyle(FontStyle newFontStyle)
          Sets the style of the font.
 void setFontWeight(double newFontWeight)
          Sets the weight of the font.
 void setLabelFontFamilies(java.util.List<java.lang.String> newLabelFontFamilies)
          Sets the font families of the label.
 void setLabelFontSize(Extent newLabelFontSize)
          Sets the label font size of the component.
 void setLabelFontStyle(FontStyle newLabelFontStyle)
          Sets the style of the label font.
 void setLabelFontWeight(double newLabelFontWeight)
          Sets the weight of the label font.
 void setLabelTextColor(Color newLabelTextColor)
          Sets the text color of the label.
 void setLineExtent(Extent newExtent)
          Sets the extent of the line flow.
 void setMarginExtent(Border border, Extent newMarginExtent)
          Sets the margin extent of a given border.
 void setMarginExtent(Extent newMarginExtent)
          Sets the margin extent of all borders.
 void setMarginLineFarExtent(Extent newMarginExtent)
          Sets the margin extent of the line far border.
 void setMarginLineNearExtent(Extent newMarginExtent)
          Sets the margin extent of the line near border.
 void setMarginPageFarExtent(Extent newMarginExtent)
          Sets the margin extent of the page far border.
 void setMarginPageNearExtent(Extent newMarginExtent)
          Sets the margin extent of the page near border.
 void setOpacity(double newOpacity)
          Sets the opacity of the entire component.
 void setPaddingExtent(Border border, Extent newPaddingExtent)
          Sets the padding extent of a given border.
 void setPaddingExtent(Extent newPaddingExtent)
          Sets the padding extent of all borders.
 void setPaddingLineFarExtent(Extent newPaddingExtent)
          Sets the padding extent of the line far border.
 void setPaddingLineNearExtent(Extent newPaddingExtent)
          Sets the padding extent of the line near border.
 void setPaddingPageFarExtent(Extent newPaddingExtent)
          Sets the padding extent of the page far border.
 void setPaddingPageNearExtent(Extent newPaddingExtent)
          Sets the padding extent of the page near border.
 void setPageExtent(Extent newExtent)
          Sets the extent of the page flow.
 void setStyleID(java.lang.String newStyleID)
          Identifies the style for the component.
 void setTextColor(Color newTextColor)
          Sets the text color of the component.
 void setTooltipEnabled(boolean newTooltipEnabled)
          Sets whether tooltips are enabled for this component.
 void setVisible(boolean newVisible)
          Sets whether the component is visible.
 
Methods inherited from class com.guiseframework.event.GuiseBoundPropertyObject
getSession
 
Methods inherited from class com.globalmentor.beans.BoundPropertyObject
addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.guiseframework.model.ui.PresentationModel
getSession
 
Methods inherited from interface com.globalmentor.beans.PropertyBindable
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
 
Methods inherited from interface com.globalmentor.beans.PropertyConstrainable
addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
 

Constructor Detail

AbstractPresentationModel

public AbstractPresentationModel()
Default constructor.

Method Detail

getBackgroundColor

public Color getBackgroundColor()
Specified by:
getBackgroundColor in interface PresentationModel
Returns:
The background color of the component, or null if no background color is specified for this component.

setBackgroundColor

public void setBackgroundColor(Color newBackgroundColor)
Sets the background color of the component. This is a bound property.

Specified by:
setBackgroundColor in interface PresentationModel
Parameters:
newBackgroundColor - The background color of the component, or null if the default background color should be used.
See Also:
PresentationModel.BACKGROUND_COLOR_PROPERTY

getBorderColor

public Color getBorderColor(Border border)
Returns the border color of the indicated border.

Specified by:
getBorderColor in interface PresentationModel
Parameters:
border - The border for which a border color should be returned.
Returns:
The border color of the given border, or null if the default border color should be used.

BorderLineNearColor

public Color BorderLineNearColor()
Returns the border color of the line near page near border.

Specified by:
BorderLineNearColor in interface PresentationModel
Returns:
The border color of the border, or null if the default border color should be used.

BorderLineFarColor

public Color BorderLineFarColor()
Returns the border color of the line far page near border.

Specified by:
BorderLineFarColor in interface PresentationModel
Returns:
The border color of the border, or null if the default border color should be used.

BorderPageNearColor

public Color BorderPageNearColor()
Returns the border color of the line near page far border.

Specified by:
BorderPageNearColor in interface PresentationModel
Returns:
The border color of the border, or null if the default border color should be used.

BorderPageFarColor

public Color BorderPageFarColor()
Returns the border color of the line far page far border.

Specified by:
BorderPageFarColor in interface PresentationModel
Returns:
The border color of the border, or null if the default border color should be used.

setBorderColor

public void setBorderColor(Border border,
                           Color newBorderColor)
Sets the border color of a given border. The border color of each border represents a bound property.

Specified by:
setBorderColor in interface PresentationModel
Parameters:
border - The border for which the border color should be set.
newBorderColor - The border color, or null if the default border color should be used.
Throws:
java.lang.NullPointerException - if the given border is null.
See Also:
PresentationModel.BORDER_LINE_NEAR_COLOR_PROPERTY, PresentationModel.BORDER_LINE_FAR_COLOR_PROPERTY, PresentationModel.BORDER_PAGE_NEAR_COLOR_PROPERTY, PresentationModel.BORDER_PAGE_FAR_COLOR_PROPERTY

setBorderLineNearColor

public void setBorderLineNearColor(Color newBorderColor)
Sets the border COLOR of the line near border. This is a bound property.

Specified by:
setBorderLineNearColor in interface PresentationModel
Parameters:
newBorderColor - The border color, or null if the default border color should be used.
See Also:
PresentationModel.BORDER_LINE_NEAR_COLOR_PROPERTY

setBorderLineFarColor

public void setBorderLineFarColor(Color newBorderColor)
Sets the border color of the line far border. This is a bound property.

Specified by:
setBorderLineFarColor in interface PresentationModel
Parameters:
newBorderColor - The border color, or null if the default border color should be used.
See Also:
PresentationModel.BORDER_LINE_FAR_COLOR_PROPERTY

setBorderPageNearColor

public void setBorderPageNearColor(Color newBorderColor)
Sets the border color of the page near border. This is a bound property.

Specified by:
setBorderPageNearColor in interface PresentationModel
Parameters:
newBorderColor - The border color, or null if the default border color should be used.
See Also:
PresentationModel.BORDER_PAGE_NEAR_COLOR_PROPERTY

setBorderPageFarColor

public void setBorderPageFarColor(Color newBorderColor)
Sets the border color of the page far border. This is a bound property.

Specified by:
setBorderPageFarColor in interface PresentationModel
Parameters:
newBorderColor - The border color, or null if the default border color should be used.
See Also:
PresentationModel.BORDER_PAGE_FAR_COLOR_PROPERTY

setBorderColor

public void setBorderColor(Color newBorderColor)
Sets the border color of all borders. The border color of each border represents a bound property. This is a convenience method that calls setBorderColor(Border, Color) for each border.

Specified by:
setBorderColor in interface PresentationModel
Parameters:
newBorderColor - The border color, or null if the default border color should be used.
See Also:
PresentationModel.BORDER_LINE_NEAR_COLOR_PROPERTY, PresentationModel.BORDER_LINE_FAR_COLOR_PROPERTY, PresentationModel.BORDER_PAGE_NEAR_COLOR_PROPERTY, PresentationModel.BORDER_PAGE_FAR_COLOR_PROPERTY

getBorderExtent

public Extent getBorderExtent(Border border)
Returns the border extent of the indicated border.

Specified by:
getBorderExtent in interface PresentationModel
Parameters:
border - The border for which a border extent should be returned.
Returns:
The border extent of the given border.

BorderLineNearExtent

public Extent BorderLineNearExtent()
Returns the border extent of the line near page near border.

Specified by:
BorderLineNearExtent in interface PresentationModel
Returns:
The border extent of the given border.

BorderLineFarExtent

public Extent BorderLineFarExtent()
Returns the border extent of the line far page near border.

Specified by:
BorderLineFarExtent in interface PresentationModel
Returns:
The border extent of the given border.

BorderPageNearExtent

public Extent BorderPageNearExtent()
Returns the border extent of the line near page far border.

Specified by:
BorderPageNearExtent in interface PresentationModel
Returns:
The border extent of the given border.

BorderPageFarExtent

public Extent BorderPageFarExtent()
Returns the border extent of the line far page far border.

Specified by:
BorderPageFarExtent in interface PresentationModel
Returns:
The border extent of the given border.

setBorderExtent

public void setBorderExtent(Border border,
                            Extent newBorderExtent)
Sets the border extent of a given border. The border extent of each border represents a bound property.

Specified by:
setBorderExtent in interface PresentationModel
Parameters:
border - The border for which the border extent should be set.
newBorderExtent - The border extent.
Throws:
java.lang.NullPointerException - if the given border and/or border extent is null.
See Also:
PresentationModel.BORDER_LINE_NEAR_EXTENT_PROPERTY, PresentationModel.BORDER_LINE_FAR_EXTENT_PROPERTY, PresentationModel.BORDER_PAGE_NEAR_EXTENT_PROPERTY, PresentationModel.BORDER_PAGE_FAR_EXTENT_PROPERTY

setBorderLineNearExtent

public void setBorderLineNearExtent(Extent newBorderExtent)
Sets the border extent of the line near border. This is a bound property.

Specified by:
setBorderLineNearExtent in interface PresentationModel
Parameters:
newBorderExtent - The border extent.
Throws:
java.lang.NullPointerException - if the given border extent is null.
See Also:
PresentationModel.BORDER_LINE_NEAR_EXTENT_PROPERTY

setBorderLineFarExtent

public void setBorderLineFarExtent(Extent newBorderExtent)
Sets the border extent of the line far border. This is a bound property.

Specified by:
setBorderLineFarExtent in interface PresentationModel
Parameters:
newBorderExtent - The border extent.
Throws:
java.lang.NullPointerException - if the given border extent is null.
See Also:
PresentationModel.BORDER_LINE_FAR_EXTENT_PROPERTY

setBorderPageNearExtent

public void setBorderPageNearExtent(Extent newBorderExtent)
Sets the border extent of the page near border. This is a bound property.

Specified by:
setBorderPageNearExtent in interface PresentationModel
Parameters:
newBorderExtent - The border extent.
Throws:
java.lang.NullPointerException - if the given border extent is null.
See Also:
PresentationModel.BORDER_PAGE_NEAR_EXTENT_PROPERTY

setBorderPageFarExtent

public void setBorderPageFarExtent(Extent newBorderExtent)
Sets the border extent of the page far border. This is a bound property.

Specified by:
setBorderPageFarExtent in interface PresentationModel
Parameters:
newBorderExtent - The border extent.
Throws:
java.lang.NullPointerException - if the given border extent is null.
See Also:
PresentationModel.BORDER_PAGE_FAR_EXTENT_PROPERTY

setBorderExtent

public void setBorderExtent(Extent newBorderExtent)
Sets the border extent of all borders. The border extent of each border represents a bound property. This is a convenience method that calls setBorderExtent(Border, Extent) for each border.

Specified by:
setBorderExtent in interface PresentationModel
Parameters:
newBorderExtent - The border extent.
Throws:
java.lang.NullPointerException - if the given border extent is null.
See Also:
PresentationModel.BORDER_LINE_NEAR_EXTENT_PROPERTY, PresentationModel.BORDER_LINE_FAR_EXTENT_PROPERTY, PresentationModel.BORDER_PAGE_NEAR_EXTENT_PROPERTY, PresentationModel.BORDER_PAGE_FAR_EXTENT_PROPERTY

getBorderStyle

public LineStyle getBorderStyle(Border border)
Returns the border style of the indicated border.

Specified by:
getBorderStyle in interface PresentationModel
Parameters:
border - The border for which a border style should be returned.
Returns:
The border style of the given border.

BorderLineNearStyle

public LineStyle BorderLineNearStyle()
Returns the border style of the line near page near border.

Specified by:
BorderLineNearStyle in interface PresentationModel
Returns:
The border style of the given border.

BorderLineFarStyle

public LineStyle BorderLineFarStyle()
Returns the border style of the line far page near border.

Specified by:
BorderLineFarStyle in interface PresentationModel
Returns:
The border style of the given border.

BorderPageNearStyle

public LineStyle BorderPageNearStyle()
Returns the border style of the line near page far border.

Specified by:
BorderPageNearStyle in interface PresentationModel
Returns:
The border style of the given border.

BorderPageFarStyle

public LineStyle BorderPageFarStyle()
Returns the border style of the line far page far border.

Specified by:
BorderPageFarStyle in interface PresentationModel
Returns:
The border style of the given border.

setBorderStyle

public void setBorderStyle(Border border,
                           LineStyle newBorderStyle)
Sets the border style of a given border. The border style of each border represents a bound property.

Specified by:
setBorderStyle in interface PresentationModel
Parameters:
border - The border for which the border style should be set.
newBorderStyle - The border style.
Throws:
java.lang.NullPointerException - if the given border and/or border style is null.
See Also:
PresentationModel.BORDER_LINE_NEAR_STYLE_PROPERTY, PresentationModel.BORDER_LINE_FAR_STYLE_PROPERTY, PresentationModel.BORDER_PAGE_NEAR_STYLE_PROPERTY, PresentationModel.BORDER_PAGE_FAR_STYLE_PROPERTY

setBorderLineNearStyle

public void setBorderLineNearStyle(LineStyle newBorderStyle)
Sets the border style of the line near border. This is a bound property.

Specified by:
setBorderLineNearStyle in interface PresentationModel
Parameters:
newBorderStyle - The border style.
Throws:
java.lang.NullPointerException - if the given border style is null.
See Also:
PresentationModel.BORDER_LINE_NEAR_STYLE_PROPERTY

setBorderLineFarStyle

public void setBorderLineFarStyle(LineStyle newBorderStyle)
Sets the border style of the line far border. This is a bound property.

Specified by:
setBorderLineFarStyle in interface PresentationModel
Parameters:
newBorderStyle - The border style.
Throws:
java.lang.NullPointerException - if the given border style is null.
See Also:
PresentationModel.BORDER_LINE_FAR_STYLE_PROPERTY

setBorderPageNearStyle

public void setBorderPageNearStyle(LineStyle newBorderStyle)
Sets the border style of the page near border. This is a bound property.

Specified by:
setBorderPageNearStyle in interface PresentationModel
Parameters:
newBorderStyle - The border style.
Throws:
java.lang.NullPointerException - if the given border style is null.
See Also:
PresentationModel.BORDER_PAGE_NEAR_STYLE_PROPERTY

setBorderPageFarStyle

public void setBorderPageFarStyle(LineStyle newBorderStyle)
Sets the border style of the page far border. This is a bound property.

Specified by:
setBorderPageFarStyle in interface PresentationModel
Parameters:
newBorderStyle - The border style.
Throws:
java.lang.NullPointerException - if the given border style is null.
See Also:
PresentationModel.BORDER_PAGE_FAR_STYLE_PROPERTY

setBorderStyle

public void setBorderStyle(LineStyle newBorderStyle)
Sets the border style of all borders. The border style of each border represents a bound property. This is a convenience method that calls setBorderStyle(Border, LineStyle) for each border.

Specified by:
setBorderStyle in interface PresentationModel
Parameters:
newBorderStyle - The border style.
Throws:
java.lang.NullPointerException - if the given border style is null.
See Also:
PresentationModel.BORDER_LINE_NEAR_STYLE_PROPERTY, PresentationModel.BORDER_LINE_FAR_STYLE_PROPERTY, PresentationModel.BORDER_PAGE_NEAR_STYLE_PROPERTY, PresentationModel.BORDER_PAGE_FAR_STYLE_PROPERTY

getCornerArcSize

public Dimensions getCornerArcSize(Corner corner)
Returns the arc size for the indicated corner.

Specified by:
getCornerArcSize in interface PresentationModel
Parameters:
corner - The corner for which an arc size should be returned.
Returns:
The dimensions indicating the two radiuses of the given corner arc, or dimensions of zero if the corner should not be rounded.

getCornerLineNearPageNearArcSize

public Dimensions getCornerLineNearPageNearArcSize()
Returns the arc size for the line near page near corner.

Specified by:
getCornerLineNearPageNearArcSize in interface PresentationModel
Returns:
The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.

getCornerLineFarPageNearArcSize

public Dimensions getCornerLineFarPageNearArcSize()
Returns the arc size for the line far page near corner.

Specified by:
getCornerLineFarPageNearArcSize in interface PresentationModel
Returns:
The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.

getCornerLineNearPageFarArcSize

public Dimensions getCornerLineNearPageFarArcSize()
Returns the arc size for the line near page far corner.

Specified by:
getCornerLineNearPageFarArcSize in interface PresentationModel
Returns:
The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.

getCornerLineFarPageFarArcSize

public Dimensions getCornerLineFarPageFarArcSize()
Returns the arc size for the line far page far corner.

Specified by:
getCornerLineFarPageFarArcSize in interface PresentationModel
Returns:
The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.

setCornerArcSize

public void setCornerArcSize(Corner corner,
                             Dimensions newCornerArcSize)
Sets the arc size of a given corner. The radius of each corner represents a bound property.

Specified by:
setCornerArcSize in interface PresentationModel
Parameters:
corner - The corner for which the arc size should be set.
newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.
Throws:
java.lang.NullPointerException - if the given corner and/or arc size is null.
See Also:
PresentationModel.CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, PresentationModel.CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, PresentationModel.CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, PresentationModel.CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY

setCornerLineNearPageNearArcSize

public void setCornerLineNearPageNearArcSize(Dimensions newCornerArcSize)
Sets the arc size of the line near page near corner. This is a bound property.

Specified by:
setCornerLineNearPageNearArcSize in interface PresentationModel
Parameters:
newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.
Throws:
java.lang.NullPointerException - if the given size is null.
See Also:
PresentationModel.CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY

setCornerLineFarPageNearArcSize

public void setCornerLineFarPageNearArcSize(Dimensions newCornerArcSize)
Sets the arc size of the line far page near corner. This is a bound property.

Specified by:
setCornerLineFarPageNearArcSize in interface PresentationModel
Parameters:
newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.
Throws:
java.lang.NullPointerException - if the given size is null.
See Also:
PresentationModel.CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY

setCornerLineNearPageFarArcSize

public void setCornerLineNearPageFarArcSize(Dimensions newCornerArcSize)
Sets the arc size of the line near page far corner. This is a bound property.

Specified by:
setCornerLineNearPageFarArcSize in interface PresentationModel
Parameters:
newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.
Throws:
java.lang.NullPointerException - if the given size is null.
See Also:
PresentationModel.CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY

setCornerLineFarPageFarArcSize

public void setCornerLineFarPageFarArcSize(Dimensions newCornerArcSize)
Sets the arc size of the line far page far corner. This is a bound property.

Specified by:
setCornerLineFarPageFarArcSize in interface PresentationModel
Parameters:
newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.
Throws:
java.lang.NullPointerException - if the given size is null.
See Also:
PresentationModel.CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY

setCornerArcSize

public void setCornerArcSize(Dimensions newCornerArcSize)
Sets the arc size of all corners. The radius of each corner represents a bound property. This is a convenience method that calls setCornerArcSize(Corner, Dimensions) for each corner.

Specified by:
setCornerArcSize in interface PresentationModel
Parameters:
newCornerArcSize - The dimensions indicating the two radiuses of the corners, or dimensions of zero if the corners should not be rounded.
Throws:
java.lang.NullPointerException - if the given arc size is null.
See Also:
PresentationModel.CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, PresentationModel.CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, PresentationModel.CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, PresentationModel.CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY

getCursor

public java.net.URI getCursor()
Specified by:
getCursor in interface PresentationModel
Returns:
The cursor URI, which may be a resource URI.

setCursor

public void setCursor(java.net.URI newCursor)
Sets the URI of the cursor. This is a bound property.

Specified by:
setCursor in interface PresentationModel
Parameters:
newCursor - The new URI of the cursor, which may be a resource URI.
Throws:
java.lang.NullPointerException - if the given cursor URI is null.
See Also:
PresentationModel.CURSOR_PROPERTY

getExtent

public Extent getExtent(Flow flow)
Returns the extent of the indicated flow.

Specified by:
getExtent in interface PresentationModel
Parameters:
flow - The flow for which an extent should be returned.
Returns:
The extent of the given flow.

getLineExtent

public Extent getLineExtent()
Returns the extent of the line flow. In left-to-right top-to-bottom orientation, this is commonly known as the width.

Specified by:
getLineExtent in interface PresentationModel
Returns:
The extent of the flow, or null if no preferred extent has been specified

getPageExtent

public Extent getPageExtent()
Returns the extent of the page flow. In left-to-right top-to-bottom orientation, this is commonly known as the height.

Specified by:
getPageExtent in interface PresentationModel
Returns:
The extent of the flow, or null if no preferred extent has been specified

setExtent

public void setExtent(Flow flow,
                      Extent newExtent)
Sets the extent of a given flow. The extent of each flow represents a bound property.

Specified by:
setExtent in interface PresentationModel
Parameters:
flow - The flow for which the extent should be set.
newExtent - The new requested extent of the component, or null there is no extent preference.
Throws:
java.lang.NullPointerException - if the given flow is null.
See Also:
PresentationModel.LINE_EXTENT_PROPERTY, PresentationModel.PAGE_EXTENT_PROPERTY

setLineExtent

public void setLineExtent(Extent newExtent)
Sets the extent of the line flow. In left-to-right top-to-bottom orientation, this is commonly known as the width. This is a bound property.

Specified by:
setLineExtent in interface PresentationModel
Parameters:
newExtent - The new requested extent of the component, or null there is no extent preference.
See Also:
PresentationModel.LINE_EXTENT_PROPERTY

setPageExtent

public void setPageExtent(Extent newExtent)
Sets the extent of the page flow. In left-to-right top-to-bottom orientation, this is commonly known as the height. This is a bound property.

Specified by:
setPageExtent in interface PresentationModel
Parameters:
newExtent - The new requested extent of the component, or null there is no extent preference.
See Also:
PresentationModel.PAGE_EXTENT_PROPERTY

getFontFamilies

public java.util.List<java.lang.String> getFontFamilies()
Specified by:
getFontFamilies in interface PresentationModel
Returns:
The prioritized list of font family names, or null if no font family names have been specified.

setFontFamilies

public void setFontFamilies(java.util.List<java.lang.String> newFontFamilies)
Sets the font families of the component. This is a bound property.

Specified by:
setFontFamilies in interface PresentationModel
Parameters:
newFontFamilies - The new prioritized list of font family names, or null if no font family names are specified.
See Also:
PresentationModel.FONT_FAMILIES_PROPERTY

getFontSize

public Extent getFontSize()
Specified by:
getFontSize in interface PresentationModel
Returns:
The size of the font from baseline to baseline, or null if no font size has been specified.

setFontSize

public void setFontSize(Extent newFontSize)
Sets the font size of the component. This is a bound property.

Specified by:
setFontSize in interface PresentationModel
Parameters:
newFontSize - The new size of the font from baseline to baseline, or null there is no font size specified.
See Also:
PresentationModel.FONT_SIZE_PROPERTY

getFontStyle

public FontStyle getFontStyle()
Specified by:
getFontStyle in interface PresentationModel
Returns:
The style of the font.

setFontStyle

public void setFontStyle(FontStyle newFontStyle)
Sets the style of the font. This is a bound property.

Specified by:
setFontStyle in interface PresentationModel
Parameters:
newFontStyle - The style of the font.
Throws:
java.lang.NullPointerException - if the given font style is null.
See Also:
PresentationModel.FONT_STYLE_PROPERTY

getFontWeight

public double getFontWeight()
Specified by:
getFontWeight in interface PresentationModel
Returns:
The weight of the font relative to a normal value of 0.5.

setFontWeight

public void setFontWeight(double newFontWeight)
Sets the weight of the font. The weight of the font relative to a normal value of 0.5. A font weight of 0.75 is equivalent to a bold font. It is recommended that the constant variables PresentationModel.FONT_WEIGHT_NORMAL and PresentationModel.FONT_WEIGHT_BOLD be used for the most compatibility across platforms. This is a bound property of type Double.

Specified by:
setFontWeight in interface PresentationModel
Parameters:
newFontWeight - The weight of the font relative to a normal value of 0.5.
See Also:
PresentationModel.FONT_WEIGHT_PROPERTY, PresentationModel.FONT_WEIGHT_NORMAL, PresentationModel.FONT_WEIGHT_BOLD

getLabelFontFamilies

public java.util.List<java.lang.String> getLabelFontFamilies()
Specified by:
getLabelFontFamilies in interface PresentationModel
Returns:
The prioritized list of label font family names, or null if no label font family names have been specified.

setLabelFontFamilies

public void setLabelFontFamilies(java.util.List<java.lang.String> newLabelFontFamilies)
Sets the font families of the label. This is a bound property.

Specified by:
setLabelFontFamilies in interface PresentationModel
Parameters:
newLabelFontFamilies - The new prioritized list of label font family names, or null if no label font family names are specified.
See Also:
PresentationModel.LABEL_FONT_FAMILIES_PROPERTY

getLabelFontSize

public Extent getLabelFontSize()
Specified by:
getLabelFontSize in interface PresentationModel
Returns:
The size of the label font from baseline to baseline, or null if no label font size has been specified.

setLabelFontSize

public void setLabelFontSize(Extent newLabelFontSize)
Sets the label font size of the component. This is a bound property.

Specified by:
setLabelFontSize in interface PresentationModel
Parameters:
newLabelFontSize - The new size of the label font from baseline to baseline, or null there is no label font size specified.
See Also:
PresentationModel.LABEL_FONT_SIZE_PROPERTY

getLabelFontStyle

public FontStyle getLabelFontStyle()
Specified by:
getLabelFontStyle in interface PresentationModel
Returns:
The style of the label font.

setLabelFontStyle

public void setLabelFontStyle(FontStyle newLabelFontStyle)
Sets the style of the label font. This is a bound property.

Specified by:
setLabelFontStyle in interface PresentationModel
Parameters:
newLabelFontStyle - The style of the label font.
Throws:
java.lang.NullPointerException - if the given label font style is null.
See Also:
PresentationModel.LABEL_FONT_STYLE_PROPERTY

getLabelFontWeight

public double getLabelFontWeight()
Specified by:
getLabelFontWeight in interface PresentationModel
Returns:
The weight of the label font relative to a normal value of 0.5.

setLabelFontWeight

public void setLabelFontWeight(double newLabelFontWeight)
Sets the weight of the label font. The weight of the label font relative to a normal value of 0.5. A font weight of 0.75 is equivalent to a bold font. It is recommended that the constant variables PresentationModel.FONT_WEIGHT_NORMAL and PresentationModel.FONT_WEIGHT_BOLD be used for the most compatibility across platforms. This is a bound property of type Double.

Specified by:
setLabelFontWeight in interface PresentationModel
Parameters:
newLabelFontWeight - The weight of the label font relative to a normal value of 0.5.
See Also:
PresentationModel.FONT_WEIGHT_PROPERTY, PresentationModel.FONT_WEIGHT_NORMAL, PresentationModel.FONT_WEIGHT_BOLD

getLabelTextColor

public Color getLabelTextColor()
Specified by:
getLabelTextColor in interface PresentationModel
Returns:
The text color of the label, or null if no text color is specified for the label.

setLabelTextColor

public void setLabelTextColor(Color newLabelTextColor)
Sets the text color of the label. This is a bound property.

Specified by:
setLabelTextColor in interface PresentationModel
Parameters:
newLabelTextColor - The text color of the label, or null if the default text color should be used.
See Also:
PresentationModel.LABEL_TEXT_COLOR_PROPERTY

getMarginExtent

public Extent getMarginExtent(Border border)
Returns the margin extent of the indicated border.

Specified by:
getMarginExtent in interface PresentationModel
Parameters:
border - The border for which a margin extent should be returned.
Returns:
The margin extent of the given border.

getMarginLineNearExtent

public Extent getMarginLineNearExtent()
Returns the margin extent of the line near page near border.

Specified by:
getMarginLineNearExtent in interface PresentationModel
Returns:
The margin extent of the given border.

getMarginLineFarExtent

public Extent getMarginLineFarExtent()
Returns the margin extent of the line far page near border.

Specified by:
getMarginLineFarExtent in interface PresentationModel
Returns:
The margin extent of the given border.

getMarginPageNearExtent

public Extent getMarginPageNearExtent()
Returns the margin extent of the line near page far border.

Specified by:
getMarginPageNearExtent in interface PresentationModel
Returns:
The margin extent of the given border.

getMarginPageFarExtent

public Extent getMarginPageFarExtent()
Returns the margin extent of the line far page far border.

Specified by:
getMarginPageFarExtent in interface PresentationModel
Returns:
The margin extent of the given border.

setMarginExtent

public void setMarginExtent(Border border,
                            Extent newMarginExtent)
Sets the margin extent of a given border. The margin extent of each border represents a bound property.

Specified by:
setMarginExtent in interface PresentationModel
Parameters:
border - The border for which the margin extent should be set.
newMarginExtent - The margin extent.
Throws:
java.lang.NullPointerException - if the given border and/or margin extent is null.
See Also:
PresentationModel.MARGIN_LINE_NEAR_EXTENT_PROPERTY, PresentationModel.MARGIN_LINE_FAR_EXTENT_PROPERTY, PresentationModel.MARGIN_PAGE_NEAR_EXTENT_PROPERTY, PresentationModel.MARGIN_PAGE_FAR_EXTENT_PROPERTY

setMarginLineNearExtent

public void setMarginLineNearExtent(Extent newMarginExtent)
Sets the margin extent of the line near border. This is a bound property.

Specified by:
setMarginLineNearExtent in interface PresentationModel
Parameters:
newMarginExtent - The margin extent.
Throws:
java.lang.NullPointerException - if the given margin extent is null.
See Also:
PresentationModel.MARGIN_LINE_NEAR_EXTENT_PROPERTY

setMarginLineFarExtent

public void setMarginLineFarExtent(Extent newMarginExtent)
Sets the margin extent of the line far border. This is a bound property.

Specified by:
setMarginLineFarExtent in interface PresentationModel
Parameters:
newMarginExtent - The margin extent, or null if the default margin extent should be used.
Throws:
java.lang.NullPointerException - if the given margin extent is null.
See Also:
PresentationModel.MARGIN_LINE_FAR_EXTENT_PROPERTY

setMarginPageNearExtent

public void setMarginPageNearExtent(Extent newMarginExtent)
Sets the margin extent of the page near border. This is a bound property.

Specified by:
setMarginPageNearExtent in interface PresentationModel
Parameters:
newMarginExtent - The margin extent, or null if the default margin extent should be used.
Throws:
java.lang.NullPointerException - if the given margin extent is null.
See Also:
PresentationModel.MARGIN_PAGE_NEAR_EXTENT_PROPERTY

setMarginPageFarExtent

public void setMarginPageFarExtent(Extent newMarginExtent)
Sets the margin extent of the page far border. This is a bound property.

Specified by:
setMarginPageFarExtent in interface PresentationModel
Parameters:
newMarginExtent - The margin extent, or null if the default margin extent should be used.
Throws:
java.lang.NullPointerException - if the given margin extent is null.
See Also:
PresentationModel.MARGIN_PAGE_FAR_EXTENT_PROPERTY

setMarginExtent

public void setMarginExtent(Extent newMarginExtent)
Sets the margin extent of all borders. The margin extent of each border represents a bound property. This is a convenience method that calls setMarginExtent(Border, Extent) for each border.

Specified by:
setMarginExtent in interface PresentationModel
Parameters:
newMarginExtent - The margin extent.
Throws:
java.lang.NullPointerException - if the given margin extent is null.
See Also:
PresentationModel.MARGIN_LINE_NEAR_EXTENT_PROPERTY, PresentationModel.MARGIN_LINE_FAR_EXTENT_PROPERTY, PresentationModel.MARGIN_PAGE_NEAR_EXTENT_PROPERTY, PresentationModel.MARGIN_PAGE_FAR_EXTENT_PROPERTY

getOpacity

public double getOpacity()
Specified by:
getOpacity in interface PresentationModel
Returns:
The opacity of the entire component in the range (0.0-1.0), with a default of 1.0.

setOpacity

public void setOpacity(double newOpacity)
Sets the opacity of the entire component. This is a bound property of type Double.

Specified by:
setOpacity in interface PresentationModel
Parameters:
newOpacity - The new opacity of the entire component in the range (0.0-1.0).
Throws:
java.lang.IllegalArgumentException - if the given opacity is not within the range (0.0-1.0).
See Also:
PresentationModel.OPACITY_PROPERTY

getPaddingExtent

public Extent getPaddingExtent(Border border)
Returns the padding extent of the indicated border.

Specified by:
getPaddingExtent in interface PresentationModel
Parameters:
border - The border for which a padding extent should be returned.
Returns:
The padding extent of the given border.

getPaddingLineNearExtent

public Extent getPaddingLineNearExtent()
Returns the padding extent of the line near page near border.

Specified by:
getPaddingLineNearExtent in interface PresentationModel
Returns:
The padding extent of the given border.

getPaddingLineFarExtent

public Extent getPaddingLineFarExtent()
Returns the padding extent of the line far page near border.

Specified by:
getPaddingLineFarExtent in interface PresentationModel
Returns:
The padding extent of the given border.

getPaddingPageNearExtent

public Extent getPaddingPageNearExtent()
Returns the padding extent of the line near page far border.

Specified by:
getPaddingPageNearExtent in interface PresentationModel
Returns:
The padding extent of the given border.

getPaddingPageFarExtent

public Extent getPaddingPageFarExtent()
Returns the padding extent of the line far page far border.

Specified by:
getPaddingPageFarExtent in interface PresentationModel
Returns:
The padding extent of the given border.

setPaddingExtent

public void setPaddingExtent(Border border,
                             Extent newPaddingExtent)
Sets the padding extent of a given border. The padding extent of each border represents a bound property.

Specified by:
setPaddingExtent in interface PresentationModel
Parameters:
border - The border for which the padding extent should be set.
newPaddingExtent - The padding extent.
Throws:
java.lang.NullPointerException - if the given border and/or padding extent is null.
See Also:
PresentationModel.PADDING_LINE_NEAR_EXTENT_PROPERTY, PresentationModel.PADDING_LINE_FAR_EXTENT_PROPERTY, PresentationModel.PADDING_PAGE_NEAR_EXTENT_PROPERTY, PresentationModel.PADDING_PAGE_FAR_EXTENT_PROPERTY

setPaddingLineNearExtent

public void setPaddingLineNearExtent(Extent newPaddingExtent)
Sets the padding extent of the line near border. This is a bound property.

Specified by:
setPaddingLineNearExtent in interface PresentationModel
Parameters:
newPaddingExtent - The padding extent.
Throws:
java.lang.NullPointerException - if the given padding extent is null.
See Also:
PresentationModel.PADDING_LINE_NEAR_EXTENT_PROPERTY

setPaddingLineFarExtent

public void setPaddingLineFarExtent(Extent newPaddingExtent)
Sets the padding extent of the line far border. This is a bound property.

Specified by:
setPaddingLineFarExtent in interface PresentationModel
Parameters:
newPaddingExtent - The padding extent, or null if the default padding extent should be used.
Throws:
java.lang.NullPointerException - if the given padding extent is null.
See Also:
PresentationModel.PADDING_LINE_FAR_EXTENT_PROPERTY

setPaddingPageNearExtent

public void setPaddingPageNearExtent(Extent newPaddingExtent)
Sets the padding extent of the page near border. This is a bound property.

Specified by:
setPaddingPageNearExtent in interface PresentationModel
Parameters:
newPaddingExtent - The padding extent, or null if the default padding extent should be used.
Throws:
java.lang.NullPointerException - if the given padding extent is null.
See Also:
PresentationModel.PADDING_PAGE_NEAR_EXTENT_PROPERTY

setPaddingPageFarExtent

public void setPaddingPageFarExtent(Extent newPaddingExtent)
Sets the padding extent of the page far border. This is a bound property.

Specified by:
setPaddingPageFarExtent in interface PresentationModel
Parameters:
newPaddingExtent - The padding extent, or null if the default padding extent should be used.
Throws:
java.lang.NullPointerException - if the given padding extent is null.
See Also:
PresentationModel.PADDING_PAGE_FAR_EXTENT_PROPERTY

setPaddingExtent

public void setPaddingExtent(Extent newPaddingExtent)
Sets the padding extent of all borders. The padding extent of each border represents a bound property. This is a convenience method that calls setPaddingExtent(Border, Extent) for each border.

Specified by:
setPaddingExtent in interface PresentationModel
Parameters:
newPaddingExtent - The padding extent.
Throws:
java.lang.NullPointerException - if the given padding extent is null.
See Also:
PresentationModel.PADDING_LINE_NEAR_EXTENT_PROPERTY, PresentationModel.PADDING_LINE_FAR_EXTENT_PROPERTY, PresentationModel.PADDING_PAGE_NEAR_EXTENT_PROPERTY, PresentationModel.PADDING_PAGE_FAR_EXTENT_PROPERTY

getStyleID

public java.lang.String getStyleID()
Specified by:
getStyleID in interface PresentationModel
Returns:
The style identifier, or null if there is no style ID.

setStyleID

public void setStyleID(java.lang.String newStyleID)
Identifies the style for the component. This is a bound property.

Specified by:
setStyleID in interface PresentationModel
Parameters:
newStyleID - The style identifier, or null if there is no style ID.
See Also:
PresentationModel.STYLE_ID_PROPERTY

isVisible

public boolean isVisible()
Specified by:
isVisible in interface PresentationModel
Returns:
Whether the component is visible.
See Also:
isDisplayed()

setVisible

public void setVisible(boolean newVisible)
Sets whether the component is visible. This is a bound property of type Boolean.

Specified by:
setVisible in interface PresentationModel
Parameters:
newVisible - true if the component should be visible, else false.
See Also:
PresentationModel.VISIBLE_PROPERTY, setDisplayed(boolean)

isDisplayed

public boolean isDisplayed()
Specified by:
isDisplayed in interface Displayable
Specified by:
isDisplayed in interface PresentationModel
Returns:
Whether the component is displayed or has no representation, taking up no space.
See Also:
isVisible()

setDisplayed

public void setDisplayed(boolean newDisplayed)
Sets whether the component is displayed or has no representation, taking up no space. This is a bound property of type Boolean.

Specified by:
setDisplayed in interface Displayable
Specified by:
setDisplayed in interface PresentationModel
Parameters:
newDisplayed - true if the component should be displayed, else false if the component should take up no space.
See Also:
Displayable.DISPLAYED_PROPERTY, setVisible(boolean)

getTextColor

public Color getTextColor()
Specified by:
getTextColor in interface PresentationModel
Returns:
The text color of the component, or null if no text color is specified for this component.

setTextColor

public void setTextColor(Color newTextColor)
Sets the text color of the component. This is a bound property.

Specified by:
setTextColor in interface PresentationModel
Parameters:
newTextColor - The text color of the component, or null if the default text color should be used.
See Also:
PresentationModel.TEXT_COLOR_PROPERTY

isTooltipEnabled

public boolean isTooltipEnabled()
Specified by:
isTooltipEnabled in interface PresentationModel
Returns:
Whether tooltips are enabled for this component.

setTooltipEnabled

public void setTooltipEnabled(boolean newTooltipEnabled)
Sets whether tooltips are enabled for this component. Tooltips contain information from the component model's "info" property. This is a bound property of type Boolean.

Specified by:
setTooltipEnabled in interface PresentationModel
Parameters:
newTooltipEnabled - true if the component should display tooltips, else false.
See Also:
#getInfo(), PresentationModel.TOOLTIP_ENABLED_PROPERTY


Copyright © 2005-2010 GlobalMentor, Inc. All Rights Reserved.