Package com._1c.g5.v8.dt.moxel.ui.editor.dialogs

Class HeaderFooterDialog

java.lang.Object

org.eclipse.jface.window.Window

org.eclipse.jface.dialogs.Dialog

org.eclipse.jface.dialogs.TrayDialog

org.eclipse.jface.dialogs.TitleAreaDialog

com._1c.g5.v8.dt.moxel.ui.editor.dialogs.HeaderFooterDialog

All Implemented Interfaces:

IFormattedTextEditableViewProvider, org.eclipse.jface.window.IShellProvider

public class HeaderFooterDialog
extends org.eclipse.jface.dialogs.TitleAreaDialog
implements IFormattedTextEditableViewProvider

Dialog for setting up document headers and footers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeaderFooterDialog.DialogPropertiesBuilder	Builder for HeaderFooterDialog properties

Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

org.eclipse.jface.window.Window.IExceptionHandler

Field Summary

Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK, resizeHasOccurred

Constructor Summary

Constructors

Constructor	Description
HeaderFooterDialog(org.eclipse.swt.widgets.Shell parentShell, HeaderFooterDialog.DialogPropertiesBuilder builder)	Creates new instance of HeaderFooterDialog

Method Summary

Modifier and Type	Method	Description
protected void	buttonPressed(int buttonId)
protected void	configureShell(org.eclipse.swt.widgets.Shell newShell)
protected void	createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)	Create contents of the button bar.
protected org.eclipse.swt.widgets.Control	createDialogArea(org.eclipse.swt.widgets.Composite parent)	Create contents of the dialog.
int	getFirstPageNumber()	Get first page number.
String	getFooterCenterText()	Get text of center footer part
Font	getFooterFont()	Get footer font
String	getFooterLeftText()	Get text of left footer part
String	getFooterRightText()	Get text of right footer part
VerticalAlignment	getFooterVerticalAlign()	Get footer vertical alignment
FormattedTextEditableView	getFormattedTextEditableView()	Gets actual FormattedTextEditableView
String	getHeaderCenterText()	Get text of center header part
Font	getHeaderFont()	Get header font
String	getHeaderLeftText()	Get text of left header part
String	getHeaderRightText()	Get text of right header part
VerticalAlignment	getHeaderVerticalAlign()	Get header vertical alignment
protected org.eclipse.swt.graphics.Point	getInitialSize()	Return the initial size of the dialog.
int	getOutputFooterFrom()	Get page number to start printing footer from
int	getOutputHeaderFrom()	Get page number to start printing header from
boolean	isOutputFooter()	Check if footer has to be printed
boolean	isOutputHeader()	Check if header has to be printed
protected void	okPressed()
void	setFirstPageNumber(int firstPageNumber)	Set first page number.
void	setFooterCenterText(String footerCenterText)	Set up text of center footer part
void	setFooterFont(Font footerFont)	Set up footer font
void	setFooterLeftText(String footerLeftText)	Set up text of left footer part
void	setFooterRightText(String footerRightText)	Set up text of right footer part
void	setFooterVerticalAlign(VerticalAlignment footerVerticalAlign)	Set up header vertical alignment
void	setHeaderCenterText(String headerCenterText)	Set up text of center header part
void	setHeaderFont(Font headerFont)	Set up header font
void	setHeaderLeftText(String headerLeftText)	Set up text of left header part
void	setHeaderRightText(String headerRightText)	Set up text of right header part
void	setHeaderVerticalAlign(VerticalAlignment headerVerticalAlign)	Set up header vertical alignment
void	setOutputFooter(boolean outputFooter)	Set 'display footer' aatribute value
void	setOutputFooterFrom(int outputFooterFrom)	Get page number to start printing footer from
void	setOutputHeader(boolean outputHeader)	Set up 'display header' attribute value
void	setOutputHeaderFrom(int outputHeaderFrom)	Get page number to start printing header from

Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

createContents, getErrorMessage, getMessage, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

closeTray, createButtonBar, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, isResizable, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderFooterDialog

public HeaderFooterDialog(org.eclipse.swt.widgets.Shell parentShell,
                          HeaderFooterDialog.DialogPropertiesBuilder builder)

Creates new instance of HeaderFooterDialog

Parameters:

parentShell - Shell

builder - HeaderFooterDialog.DialogPropertiesBuilder

Method Detail

isOutputHeader

public boolean isOutputHeader()

Check if header has to be printed

Returns:

true if header is printed, false otherwise

setOutputHeader

public void setOutputHeader(boolean outputHeader)

Set up 'display header' attribute value

Parameters:

outputHeader - value to be set

getOutputHeaderFrom

public int getOutputHeaderFrom()

Get page number to start printing header from

Returns:

page number

setOutputHeaderFrom

public void setOutputHeaderFrom(int outputHeaderFrom)

Get page number to start printing header from

Parameters:

outputHeaderFrom - page number

getHeaderVerticalAlign

public VerticalAlignment getHeaderVerticalAlign()

Get header vertical alignment

Returns:

VerticalAlignment

setHeaderVerticalAlign

public void setHeaderVerticalAlign(VerticalAlignment headerVerticalAlign)

Set up header vertical alignment

Parameters:

headerVerticalAlign - VerticalAlignment

getHeaderFont

public Font getHeaderFont()

Get header font

Returns:

Font

setHeaderFont

public void setHeaderFont(Font headerFont)

Set up header font

Parameters:

headerFont - Font

getHeaderLeftText

public String getHeaderLeftText()

Get text of left header part

Returns:

text of left header part

setHeaderLeftText

public void setHeaderLeftText(String headerLeftText)

Set up text of left header part

Parameters:

headerLeftText - text to be set

getHeaderCenterText

public String getHeaderCenterText()

Get text of center header part

Returns:

text of center header part

setHeaderCenterText

public void setHeaderCenterText(String headerCenterText)

Set up text of center header part

Parameters:

headerCenterText - text to be set

getHeaderRightText

public String getHeaderRightText()

Get text of right header part

Returns:

text of right header part

setHeaderRightText

public void setHeaderRightText(String headerRightText)

Set up text of right header part

Parameters:

headerCenterText - text to be set

isOutputFooter

public boolean isOutputFooter()

Check if footer has to be printed

Returns:

true if footer is printed, false otherwise

setOutputFooter

public void setOutputFooter(boolean outputFooter)

Set 'display footer' aatribute value

Parameters:

outputFooter - value to be set

getOutputFooterFrom

public int getOutputFooterFrom()

Get page number to start printing footer from

Returns:

page number

setOutputFooterFrom

public void setOutputFooterFrom(int outputFooterFrom)

Get page number to start printing footer from

Parameters:

outputFooterFrom - page number

getFooterVerticalAlign

public VerticalAlignment getFooterVerticalAlign()

Get footer vertical alignment

Returns:

VerticalAlignment

setFooterVerticalAlign

public void setFooterVerticalAlign(VerticalAlignment footerVerticalAlign)

Set up header vertical alignment

Parameters:

headerVerticalAlign - VerticalAlignment

getFooterFont

public Font getFooterFont()

Get footer font

Returns:

Font

setFooterFont

public void setFooterFont(Font footerFont)

Set up footer font

Parameters:

footerFont - Font

getFooterLeftText

public String getFooterLeftText()

Get text of left footer part

Returns:

text of left footer part

setFooterLeftText

public void setFooterLeftText(String footerLeftText)

Set up text of left footer part

Parameters:

footerLeftText - text to be set

getFooterCenterText

public String getFooterCenterText()

Get text of center footer part

Returns:

text of center footer part

setFooterCenterText

public void setFooterCenterText(String footerCenterText)

Set up text of center footer part

Parameters:

footerLeftText - text to be set

getFooterRightText

public String getFooterRightText()

Get text of right footer part

Returns:

text of right footer part

setFooterRightText

public void setFooterRightText(String footerRightText)

Set up text of right footer part

Parameters:

footerLeftText - text to be set

getFirstPageNumber

public int getFirstPageNumber()

Get first page number.

Returns:

the firstPageNumber

setFirstPageNumber

public void setFirstPageNumber(int firstPageNumber)

Set first page number.

Parameters:

firstPageNumber - first page number

getFormattedTextEditableView

public FormattedTextEditableView getFormattedTextEditableView()

Description copied from interface: IFormattedTextEditableViewProvider

Gets actual FormattedTextEditableView

Specified by:

getFormattedTextEditableView in interface IFormattedTextEditableViewProvider

Returns:

actual FormattedTextEditableView, never null

createDialogArea

protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)

Create contents of the dialog.

Overrides:

createDialogArea in class org.eclipse.jface.dialogs.TitleAreaDialog

Parameters:

parent - Composite

createButtonsForButtonBar

protected void createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)

Create contents of the button bar.

Overrides:

createButtonsForButtonBar in class org.eclipse.jface.dialogs.Dialog

Parameters:

parent - Composite

getInitialSize

protected org.eclipse.swt.graphics.Point getInitialSize()

Return the initial size of the dialog.

Overrides:

getInitialSize in class org.eclipse.jface.dialogs.TitleAreaDialog

buttonPressed

protected void buttonPressed(int buttonId)

Overrides:

buttonPressed in class org.eclipse.jface.dialogs.Dialog

okPressed

protected void okPressed()

Overrides:

okPressed in class org.eclipse.jface.dialogs.Dialog

configureShell

protected void configureShell(org.eclipse.swt.widgets.Shell newShell)

Overrides:

configureShell in class org.eclipse.jface.window.Window