Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER Copyright 2011 IBM. All rights reserved. Use is subject to license terms. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at You can also obtain a copy of the License at Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. /
 package org.odftoolkit.simple.common.field;
A PageNumberField displays the current page number of pages in a document.

NOTE: Before the document is opened in any editor, the value of this field is invalid.

 public class PageNumberField extends Field {
 	private DisplayType type;

A DisplayType represents the selected page attribute of the field. The page immediately preceding the current page, current page and the page immediately following the current page are supported.

 	public static enum DisplayType {
 		PREVIOUS_PAGE("previous"), CURRENT_PAGE("current"), NEXT_PAGE("next");
 		private final String displayType;
 		DisplayType(String type) {
 			 = type;
 		public String toString() {
 			return ;
 	// package constructor, only called by Fields
 	PageNumberField(OdfElement odfElement) {
 		TextSpanElement spanElement = ((OdfFileDomodfElement.getOwnerDocument()).newOdfElement(TextSpanElement.class);

Specifies whether to display or not the number of a previous or following page rather than the number of the current page.

type the display type which is predefined.
 	public void setDisplayPage(DisplayType type) {
 		this. = type;

Specifies the number format of this field.

format the format which is predefined in NumberFormat.
See also:
 	public void setNumberFormat(NumberFormat format) {

Return an instance of TextPageNumberElement which represents this feature.

an instance of TextPageNumberElement
	public FieldType getFieldType() {
		switch () {
		case :
			return null;
New to GrepCode? Check out our FAQ X